FitsProperties

class sofia_redux.scan.source_models.fits_properties.fits_properties.FitsProperties

Bases: ABC

Initialize a FITS properties object.

The FITS properties generally refer to high level FITS header keywords that describe an observation/scan. These include the software name responsible for the reduction, any copyright, the filename, observed source, telescope, instrument, observer, and date.

Attributes Summary

default_copyright
default_creator
referenced_attributes	Return attribute names that should be referenced during a copy.

Methods Summary

brief([header_string])	Return a brief header summary.
copy()	Return a copy of the FITS properties.
edit_header(header)	Edit a FITS header with FITS property information.
get_table_entry(name)	Return a parameter value for a given name.
info([header_string])	Return some relevant info as a string.
parse_header(header)	Parse and apply a FITS header.
reset_processing()	Reset the processing status.
set_copyright(copyright_string)	Set the copyright.
set_creator_name(creator_name)	Set the creator name.
set_filename(filename)	Set the file name.
set_instrument_name(instrument_name)	Set the instrument name.
set_object_name(object_name)	Set the object name.
set_observation_date_string(...)	Set the observation date string.
set_observer_name(observer_name)	Set the observer name.
set_telescope_name(telescope_name)	Set the telescope name.

Attributes Documentation

default_copyright = '(c) Universities Space Research Association under Government Prime Contract Number NNA17BF53C and licensed under the terms of the BSD 3-Clause license.'

default_creator = 'SOFSCAN'

referenced_attributes

Return attribute names that should be referenced during a copy.

Returns:

set (str)

Methods Documentation

brief(header_string=None)

Return a brief header summary.

Parameters:

header_stringstr, optional

If supplied, the message will be pre-pended to this string.

Returns:

str

copy()

Return a copy of the FITS properties.

Returns:

FitsProperties

edit_header(header)

Edit a FITS header with FITS property information.

Parameters:

headerastropy.io.fits.Header

The header to update.

Returns:

None

get_table_entry(name)

Return a parameter value for a given name.

Parameters:

namestr, optional

Returns:

value

info(header_string=None)

Return some relevant info as a string.

Parameters:

header_stringstr, optional

If supplied, the message will be pre-pended to this string.

Returns:

str

parse_header(header)

Parse and apply a FITS header.

Parameters:

headerastropy.io.fits.Header

Returns:

None

reset_processing()

Reset the processing status.

Returns:

None

set_copyright(copyright_string)

Set the copyright.

Parameters:

copyright_stringstr

Returns:

None

set_creator_name(creator_name)

Set the creator name.

Parameters:

creator_namestr

Returns:

None

set_filename(filename)

Set the file name.

Parameters:

filenamestr

Returns:

None

set_instrument_name(instrument_name)

Set the instrument name.

Parameters:

instrument_namestr

Returns:

None

set_object_name(object_name)

Set the object name.

Parameters:

object_namestr

Returns:

None

set_observation_date_string(observation_date_string)

Set the observation date string.

Parameters:

observation_date_stringstr

Returns:

None

set_observer_name(observer_name)

Set the observer name.

Parameters:

observer_namestr

Returns:

None

set_telescope_name(telescope_name)

Set the telescope name.

Parameters:

telescope_namestr

Returns:

None