ExampleScan

class sofia_redux.scan.custom.example.scan.scan.ExampleScan(channels, reduction=None)

Bases: Scan

Initialize a scan for the example instrument.

Parameters:

channelsExampleChannels

The channels for the example instrument.

reductionsofia_redux.scan.reduction.reduction.Reduction, optional

The reduction to which the scan belongs.

Attributes Summary

referenced_attributes

Return the names of attributes that are referenced during a copy.

Methods Summary

close_fits()	Close the scan FITS file.
get_id()	Return the scan ID.
get_integration_instance()	Return an integration instance of the correct type for the scan.
read(filename[, read_fully])	Read a filename to populate the scan.
read_hdul(hdul[, read_fully])	Read an open FITS HDUL.
read_integration(hdul)	Add integrations to this scan from a HDU list.

Attributes Documentation

referenced_attributes

Return the names of attributes that are referenced during a copy.

Returns:

attribute_namesset (str)

Methods Documentation

close_fits()

Close the scan FITS file.

Returns:

None

get_id()

Return the scan ID.

Returns:

str

get_integration_instance()

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

Returns:

integrationExampleIntegration

read(filename, read_fully=True)

Read a filename to populate the scan.

The read should validate the channels before instantiating integrations for reading.

Parameters:

filenamestr

The name of the file to read.

read_fullybool, optional

If True, perform a full read (default)

Returns:

None

read_hdul(hdul, read_fully=True)

Read an open FITS HDUL.

Parameters:

hdulfits.HDUList

The FITS HDU list to read.

read_fullybool, optional

If True (default), fully read the file. This is irrelevant for the example instrument.

Returns:

None

read_integration(hdul)

Add integrations to this scan from a HDU list.

Parameters:

hdulfits.HDUList

Returns:

None