Module functions to retrieve metadata associated with source and background datasets.
Integer_Type get_dimension([Integer])
Float_Type get_exptime([Integer])
Float_Type get_bexptime([Integer])
Float_Type get_backscale([Integer])
Float_Type get_bbackscale([Integer])
Error Return Value: NULL
Arguments:
(1) data set number (default 1)
The function get_dimension() retrieves the dimensionality
of the appropriate data set (e.g., 1 for PHA data, 2 for images).
(If no argument is given, the dimensionality of data set 1 is retrieved.)
The function get_exptime() retrieves the exposure time
of the appropriate data set, in seconds. (The function
get_bexptime() retrieves the exposure time of the
background data set.)
The function get_backscale() retrieves the value
of the BACKSCAL keyword associated with the appropriate
data set (assuming the file from which that data was read
was a PHA file). (The function
get_bbackscale() retrieves the value of the BACKSCAL
associated with the appropriate background data set.)
See the related Sherpa command
SHOW ALL
for more information.
sherpa> data example.pha
sherpa> get_exptime()
28678
- chandra
-
guide
- sherpa
-
get_analysis,
get_arf_axes,
get_axes,
get_coord,
get_data,
get_energy_axes,
get_errors,
get_filter,
get_filter_expr,
get_fit,
get_fluxed_spectrum,
get_ftest,
get_photon_axes,
get_photon_energy_axes,
get_photon_wave_axes,
get_qvalue,
get_raw_axes,
get_record,
get_source,
get_statistic,
get_stats,
get_syserrors,
get_wave_axes,
get_weights,
record,
save,
write
|
![[CIAO Logo]](../imgs/ciao_logo_navbar.gif){kind=logo}