HawcPlusScan

class sofia_redux.scan.custom.hawc_plus.scan.scan.HawcPlusScan(channels, reduction=None)[source]

Bases: SofiaScan

Initialize a HAWC+ scan.

Parameters:
channelssofia_redux.scan.custom.sofia.channels.camera.SofiaCamera

The instrument channels for the scan.

reductionsofia_redux.scan.reduction.reduction.Reduction, optional

The reduction to which this scan belongs.

Attributes Summary

astrometry

Return the scan astrometry information.

focus_t_offset

Return the focus T offset.

info

Return the information object for the scan.

transit_tolerance

Return the chopper transit tolerance.

Methods Summary

add_integrations_from_hdul(hdul)

Add integrations to the scan integrations from an open HDUL.

copy()

Return a copy of the HawcPlusScan.

edit_scan_header(header)

Edit scan FITS header information.

get_first_frame()

Return the first frame of the first integration.

get_first_integration()

Return the first integration of the scan.

get_integration_instance()

Return an integration instance of the correct type for the scan.

get_last_frame()

Return the last frame of the last integration.

get_last_integration()

Return the last integration of the scan.

get_nominal_pointing_offset(native_pointing)

Get the nominal point offset for a native pointing coordinate.

get_table_entry(name)

Return a parameter value for the given name.

validate()

Validate the scan after a read.

Attributes Documentation

astrometry

Return the scan astrometry information.

Returns:
infoHawcPlusAstrometryInfo
focus_t_offset

Return the focus T offset.

Returns:
offsetunits.Quantity

The total focus offset, typically in um.

info

Return the information object for the scan.

The information object contains the reduction configuration and various parameters pertaining the this scan.

Returns:
HawcPlusInfo
transit_tolerance

Return the chopper transit tolerance.

Returns:
toleranceunits.Quantity

The angular transit tolerance, typically in arcseconds.

Methods Documentation

add_integrations_from_hdul(hdul)[source]

Add integrations to the scan integrations from an open HDUL.

Any “timestream” HDUs from the HDUList are read by the integration.

Parameters:
hdulastropy.io.fits.hdu.hdulist.HDUList
Returns:
None
copy()[source]

Return a copy of the HawcPlusScan.

Returns:
HawcPlusScan
edit_scan_header(header)[source]

Edit scan FITS header information.

Parameters:
headerastropy.io.fits.header.Header

The header to edit.

Returns:
None
get_first_frame()[source]

Return the first frame of the first integration.

Returns:
HawcPlusFrames
get_first_integration()[source]

Return the first integration of the scan.

Returns:
integrationHawcPlusIntegration

Will be None if no integrations exist.

get_integration_instance()[source]

Return an integration instance of the correct type for the scan.

Returns:
integrationHawcPlusIntegration
get_last_frame()[source]

Return the last frame of the last integration.

Returns:
HawcPlusFrames
get_last_integration()[source]

Return the last integration of the scan.

Returns:
integrationHawcPlusIntegration

Will be None if no integrations exist.

get_nominal_pointing_offset(native_pointing)[source]

Get the nominal point offset for a native pointing coordinate.

The nominal pointing offset ignores the reference coordinate of the supplied native_coordinate and adds the offset values to the pointing offset stored in the configuration.

Parameters:
native_pointingOffset2D

The native pointing offset. The reference position is ignored.

Returns:
nominal_pointing_offset: Coordinate2D
get_table_entry(name)[source]

Return a parameter value for the given name.

Parameters:
namestr

The name of the parameter to retrieve.

Returns:
value
validate()[source]

Validate the scan after a read.

Returns:
None