sofia_redux.scan: Scan Mode Algorithms for SOFIA Pipelines¶

The sofia_redux.scan package contains supporting algorithms and helper functions for reconstructing image maps from scanned observations.

Description¶

Architecture¶

Usage¶

Reference/API¶

sofia_redux.scan.channels¶

sofia_redux.scan.channels.channels Module¶

Classes¶

Channels([name, parent, info, size])

Creates a Channels instance.

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_numba_functions Module¶

Functions¶

`flag_weights`(channel_gain, channel_weight, ...)	Flag channels according to degrees-of-freedom and weight.
`get_typical_gain_magnitude`(gains)	Return the typical gain magnitude for a gain array.
`get_one_over_f_stat`(weights, ...)	Return the total channel 1/f statistic.
`get_source_nefd`(filtered_source_gains, ...)	Return the source Noise-Equivalent-Flux-Density (NEFD).

sofia_redux.scan.channels.camera.camera Module¶

Classes¶

Camera([name, parent, info, size])

Initialize camera channels.

Class Inheritance Diagram¶

sofia_redux.scan.channels.camera.color_arrangement Module¶

Classes¶

ColorArrangement([name, parent, info, size])

The color arrangement channels expand upon the camera channels by defining each as a pixel with a distinct resolution.

Class Inheritance Diagram¶

sofia_redux.scan.channels.camera.single_color_arrangement Module¶

Classes¶

SingleColorArrangement([name, parent, info, ...])

Expands upon the color arrangement channels by defining each pixel as a detector that receives only a single stream of data.

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.channel_data Module¶

Classes¶

ChannelData([channels])

Initialize channel data.

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.color_arrangement_data Module¶

Classes¶

ColorArrangementData([channels])

Expands upon the channel data by defining each channel as a pixel on a camera with a distinct resolution.

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.single_color_channel_data Module¶

Classes¶

SingleColorChannelData([channels])

Initialize single color channel data.

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_group.channel_group Module¶

Classes¶

ChannelGroup(channel_data[, indices, name])

Create a channel group from channel data.

Class Inheritance Diagram¶

sofia_redux.scan.channels.division.division Module¶

Classes¶

ChannelDivision(name[, groups])

Instantiates a channel division.

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.gain_provider Module¶

Classes¶

GainProvider()

The gain provider is an abstract class template, used to extract and set gain values for channel data.

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.field_gain_provider Module¶

Classes¶

FieldGainProvider(field)

Initializes a field gain provider.

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.sky_gradient Module¶

Classes¶

SkyGradient([horizontal])

Creates a SkyGradient gain provider.

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.zero_mean_gains Module¶

Classes¶

ZeroMeanGains()

An abstract class designed to subtract average gain values.

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.modality Module¶

Classes¶

Modality([name, identity, channel_division, ...])

Create a Modality.

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.correlated_modality Module¶

Classes¶

CorrelatedModality([name, identity, ...])

Create a correlated modality.

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.coupled_modality Module¶

Classes¶

CoupledModality(modality[, name, identity, ...])

Create a coupled modality.

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.non_linear_modality Module¶

Classes¶

NonlinearModality(modality[, name, ...])

Create a non-linear modality.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.mode Module¶

Classes¶

Mode([channel_group, gain_provider, name])

Create a mode operating on a given channel group.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.response Module¶

Classes¶

Response([channel_group, gain_provider, name])

An abstract response mode.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.acceleration_response Module¶

Classes¶

AccelerationResponse([channel_group, ...])

Creates a position response mode based on acceleration.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.chopper_response Module¶

Classes¶

ChopperResponse([channel_group, ...])

Creates a position response mode based on CHOPPER position.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.correlated_mode Module¶

Classes¶

CorrelatedMode([channel_group, ...])

Create a correlated mode operating on a given channel group.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.field_response Module¶

Classes¶

FieldResponse([channel_group, ...])

Returns a field response mode.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.motion_response Module¶

Classes¶

MotionResponse([channel_group, ...])

An abstract response mode class.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.non_linear_response Module¶

Classes¶

NonLinearResponse(mode[, gain_provider, name])

Create a non-linear response mode.

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.pointing_response Module¶

Classes¶

PointingResponse([channel_group, ...])

Creates a position response mode based on TELESCOPE position.

Class Inheritance Diagram¶

sofia_redux.scan.channels.rotating.rotating Module¶

Classes¶

Rotating()

Class Inheritance Diagram¶

sofia_redux.scan.chopper¶

sofia_redux.scan.chopper.chopper Module¶

Classes¶

Chopper([x, y, time, threshold])

Initialize the chopper object.

Class Inheritance Diagram¶

sofia_redux.scan.chopper.chopper_numba_functions Module¶

Functions¶

find_transitions(x, y, threshold)

Given (x, y) chopper positions, find the transitions and other parameters.

sofia_redux.scan.configuration¶

sofia_redux.scan.configuration.configuration Module¶

Classes¶

Configuration([configuration_path, ...])

A handler for configuration settings used during a SOFSCAN reduction.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.aliases Module¶

Classes¶

Aliases([allow_error, verbose])

Initialize the configuration aliases.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.conditions Module¶

Classes¶

Conditions([allow_error, verbose])

Initialize the configuration conditions.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.dates Module¶

Classes¶

`DateRangeOptions`([allow_error, verbose])	Initialize the date range options.
`DateRange`(text)	Initialize a date range from a text string.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.fits Module¶

Classes¶

FitsOptions([allow_error, verbose])

Initialize the FITS options.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.iterations Module¶

Classes¶

IterationOptions([allow_error, verbose, ...])

Initialize the configuration iteration options.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.objects Module¶

Classes¶

ObjectOptions([allow_error, verbose])

Initialize the object options.

Class Inheritance Diagram¶

sofia_redux.scan.configuration.options Module¶

Classes¶

Options([allow_error, verbose])

Initialize an Options object.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems¶

sofia_redux.scan.coordinate_systems.coordinate_system Module¶

Classes¶

CoordinateSystem([name, dimensions])

Initialize a coordinate system.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.coordinate_systems_numba_functions Module¶

Functions¶

`check_null`(coordinates)	Check if coordinates are zeroed.
`check_nan`(coordinates)	Check if coordinates are NaN.
`check_finite`(coordinates)	Check if coordinates are finite.
`check_infinite`(coordinates)	Check if coordinates are infinite.
`check_value`(value, coordinates)	Check if coordinates are equal to a given value in all dimensions.
`spherical_distance_to`(x, rx, cos_lat, ...)	Return the angular distance in radians between spherical coordinate sets.
`spherical_pole_transform`(x, px, cos_lat, ...)	Transform spherical coordinates to a new pole.

sofia_redux.scan.coordinate_systems.cartesian_system Module¶

Classes¶

CartesianSystem([axes])

Initialize a cartesian system of coordinate axes.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.coordinate Module¶

Classes¶

Coordinate([coordinates, unit, copy])

Initialize a coordinate.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.coordinate_2d Module¶

Classes¶

Coordinate2D([coordinates, unit, copy])

The Coordinate2D is a specialized extension of the Coordinate class for 2-dimensional (x, y) data.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.coordinate_axis Module¶

Classes¶

CoordinateAxis([label, short_label, unit])

Initialize a coordinate axis used for a coordinate system.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.index_2d Module¶

Classes¶

Index2D([coordinates, copy])

Initialize 2-dimensional indexing coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.offset_2d Module¶

Classes¶

Offset2D(reference[, coordinates, unit, copy])

Initialize a 2-dimensional offset.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.celestial_coordinates Module¶

Classes¶

CelestialCoordinates([coordinates, unit, copy])

Initialize a CelestialCoordinates object.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.ecliptic_coordinates Module¶

Classes¶

EclipticCoordinates([coordinates, unit, ...])

Initialize ecliptic coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.equatorial_coordinates Module¶

Classes¶

EquatorialCoordinates([coordinates, unit, ...])

Initialize equatorial coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.focal_plane_coordinates Module¶

Classes¶

FocalPlaneCoordinates([coordinates, unit, copy])

Initialize focal plane coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.galactic_coordinates Module¶

Classes¶

GalacticCoordinates([coordinates, unit, copy])

Initialize galactic coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.geocentric_coordinates Module¶

Classes¶

GeocentricCoordinates([coordinates, unit, copy])

Initialize geocentric coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.geodetic_coordinates Module¶

Classes¶

GeodeticCoordinates([coordinates, unit, copy])

Initialize geodetic coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.horizontal_coordinates Module¶

Classes¶

HorizontalCoordinates([coordinates, unit, copy])

Initialize horizontal coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.precessing_coordinates Module¶

Classes¶

PrecessingCoordinates([coordinates, unit, ...])

Initialize a PrecessingCoordinates object.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.spherical_coordinates Module¶

Classes¶

SphericalCoordinates([coordinates, unit, copy])

Initialize a SphericalCoordinates object.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.super_galactic_coordinates Module¶

Classes¶

SuperGalacticCoordinates([coordinates, ...])

Initialize a set of super-galactic coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.telescope_coordinates Module¶

Classes¶

TelescopeCoordinates([coordinates, unit, copy])

Initialize a set of telescope coordinates.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.epoch.epoch Module¶

Classes¶

`Epoch`([equinox, immutable])	Initialize an astronomical epoch.
`JulianEpoch`([equinox, immutable])	Initialize a Julian epoch.
`BesselianEpoch`([equinox, immutable])	Initialize a Besselian epoch.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.epoch.precession Module¶

Classes¶

Precession(from_epoch, to_epoch)

Initialize a precession object.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.epoch.precession_numba_functions Module¶

Functions¶

`precess_single`(p, ra, dec, cos_lat, sin_lat)	Precess the coordinates with a precession matrix.
`precess_times`(p, ra, dec, cos_lat, sin_lat)	Precess the coordinates with a precession matrix.

sofia_redux.scan.coordinate_systems.grid.grid Module¶

Classes¶

Grid()

Initialize a Grid.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.grid.grid_2d Module¶

Classes¶

Grid2D()

Initialize a 2-dimensional abstract grid.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.grid.flat_grid_2d Module¶

Classes¶

FlatGrid2D()

Initialize a flat 2-dimensional grid.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.grid.spherical_grid Module¶

Classes¶

SphericalGrid([reference])

Initialize a spherical grid.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.projection_2d Module¶

Classes¶

Projection2D()

Initialize an abstract 2D projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.projection_numba_functions Module¶

Functions¶

`spherical_project_array`(x, y, cos_lat, ...)	Project multiple coordinates from a native pole onto a celestial pole.
`spherical_project`(x, y, cos_lat, sin_lat, ...)	Convert a single coordinate form a native pole to a celestial pole.
`spherical_deproject_array`(phi, theta, ...)	Project multiple coordinates from a celestial pole onto a native pole.
`spherical_deproject`(phi, theta, ...)	Deproject single coordinates about a celestial pole to a native pole.
`calculate_celestial_pole_array`(...)	Calculate the celestial pole when one or more of the inputs are arrays.
`calculate_celestial_pole`(native_reference_x, ...)	Calculate a celestial pole based on a reference and native reference.
`equal_angles`(a1, a2[, angular_accuracy])	Check if two angles are equal within accuracy.
`asin`(value)	Return the inverse sine of a value.
`asin_array`(values)	Return the inverse sine for an array of values.
`acos`(value)	Return the inverse cosine of an angle.
`acos_array`(values)	Return the inverse cosine for an array of values

sofia_redux.scan.coordinate_systems.projection.default_projection_2d Module¶

Classes¶

DefaultProjection2D()

Initialize a default 2-dimensional Cartesian projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.bonnes_projection Module¶

Classes¶

BonnesProjection()

Initialize a Bonne spherical projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.cylindrical_projection Module¶

Classes¶

CylindricalProjection()

An abstract cylindrical projection class.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.cylindrical_equal_area_projection Module¶

Classes¶

CylindricalEqualAreaProjection()

Initialize a cylindrical equal-area projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.cylindrical_perspective_projection Module¶

Classes¶

CylindricalPerspectiveProjection()

Create a cylindrical perspective projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.global_sinusoidal_projection Module¶

Classes¶

GlobalSinusoidalProjection()

Initialize a global sinusoidal projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.gnomonic_projection Module¶

Classes¶

GnomonicProjection()

Initialize a gnomonic projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.hammer_aitoff_projection Module¶

Classes¶

HammerAitoffProjection()

Initialize a Hammer-Aitoff projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.mercator_projection Module¶

Classes¶

MercatorProjection()

Initialize a Mercator projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.parabolic_projection Module¶

Classes¶

ParabolicProjection()

Initialize a parabolic projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.plate_carree_projection Module¶

Classes¶

PlateCarreeProjection()

Initialize a plate carree projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.polyconic_projection Module¶

Classes¶

PolyconicProjection()

Initialize a polyconic projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.sanson_flamsteed_projection Module¶

Classes¶

SansonFlamsteedProjection()

Initialize a Sanson-Flamsteed projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.slant_orthographic_projection Module¶

Classes¶

SlantOrthographicProjection()

Initialize a slant orthographic projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.spherical_projection Module¶

Classes¶

SphericalProjection()

Initialize a spherical projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.stereographic_projection Module¶

Classes¶

StereographicProjection()

Initialize a stereographic projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.zenithal_equal_area_projection Module¶

Classes¶

ZenithalEqualAreaProjection()

Initialize a zenithal equal-area projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.zenithal_equidistant_projection Module¶

Classes¶

ZenithalEquidistantProjection()

Initialize a zenithal equidistant projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projection.zenithal_projection Module¶

Classes¶

ZenithalProjection()

Initialization for the abstract zenithal projection.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projector.projector_2d Module¶

Classes¶

Projector2D(projection)

Initialize a 2-D projector.

Class Inheritance Diagram¶

sofia_redux.scan.coordinate_systems.projector.astro_projector Module¶

Classes¶

AstroProjector(projection)

Initialize an astronomical projector.

Class Inheritance Diagram¶

sofia_redux.scan.custom¶

sofia_redux.scan.custom.example.channels.channels Module¶

Classes¶

ExampleChannels([parent, info, size, name])

Initialize channels for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.channels.channel_data.channel_data Module¶

Classes¶

ExampleChannelData([channels])

Initialize the channel data for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.channels.channel_group.channel_group Module¶

Classes¶

ExampleChannelGroup(channel_data[, indices, ...])

Initialize a channel group for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.flags.channel_flags Module¶

Classes¶

ExampleChannelFlags()

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.flags.frame_flags Module¶

Classes¶

ExampleFrameFlags()

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.frames.frames Module¶

Classes¶

ExampleFrames()

Initialize frames for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.info Module¶

Classes¶

ExampleInfo([configuration_path])

Initialize an ExampleInfo object.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.astrometry Module¶

Classes¶

ExampleAstrometryInfo()

Initialize the astrometry info for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.detector_array Module¶

Classes¶

ExampleDetectorArrayInfo()

Initialize the detector array information for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.instrument Module¶

Classes¶

ExampleInstrumentInfo()

Initialize the instrument information for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.observation Module¶

Classes¶

ExampleObservationInfo()

Initialize the observation information for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.info.telescope Module¶

Classes¶

ExampleTelescopeInfo()

Initialize the telescope information for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.integration.integration Module¶

Classes¶

ExampleIntegration([scan])

Initialize an example integration.

Class Inheritance Diagram¶

sofia_redux.scan.custom.example.scan.scan Module¶

Classes¶

ExampleScan(channels[, reduction])

Initialize a scan for the example instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.channels Module¶

Classes¶

HawcPlusChannels([parent, info, size, name])

Initialize HAWC+ channels.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.channel_data.channel_data Module¶

Classes¶

HawcPlusChannelData([channels])

Initialize the channel data for the HAWC+ instrument.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.channel_group.channel_group Module¶

Classes¶

HawcPlusChannelGroup(channel_data[, ...])

Initialize a HAWC+ channel group.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.gain_provider.pol_imbalance Module¶

Classes¶

HawcPlusPolImbalance()

A gain provider that returns 1.0 for pol 0 channels and -1.0 otherwise.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.mode.los_response Module¶

Classes¶

LosResponse([channel_group, gain_provider, name])

Initialize a LOS response mode.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.channels.mode.roll_response Module¶

Classes¶

RollResponse([channel_group, gain_provider, ...])

Initialize a roll response mode.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.flags.channel_flags Module¶

Classes¶

HawcPlusChannelFlags()

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.flags.frame_flags Module¶

Classes¶

HawcPlusFrameFlags()

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.frames.frames Module¶

Classes¶

HawcPlusFrames()

Initialize HAWC+ frames.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.frames.hawc_plus_frame_numba_functions Module¶

Functions¶

`validate`(valid, validated, status, ...)	Utility function to validate HAWC+ frames following a data read.
`dark_correct`(data, valid_frame, ...)	Perform the dark correction.
`downsample_hwp_angle`(hwp_angle, ...)	Return a downsampled HWP angle array.

sofia_redux.scan.custom.hawc_plus.info.info Module¶

Classes¶

HawcPlusInfo([configuration_path])

Initialize a HawcPlusInfo object.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.astrometry Module¶

Classes¶

HawcPlusAstrometryInfo()

Initialize astrometry information for HAWC+ observations.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.chopping Module¶

Classes¶

HawcPlusChoppingInfo()

Initialize the HAWC+ chopping information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.detector_array Module¶

Classes¶

HawcPlusDetectorArrayInfo()

Initialize the HAWC+ detector array information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.instrument Module¶

Classes¶

HawcPlusInstrumentInfo()

Initialize the HAWC+ instrument information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.observation Module¶

Classes¶

HawcPlusObservationInfo()

Initialize the SOFIA observation information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.info.telescope Module¶

Classes¶

HawcPlusTelescopeInfo()

Initialize the HAWC+ telescope information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.integration.integration Module¶

Classes¶

HawcPlusIntegration([scan])

Initialize a HAWC+ integration.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.integration.hawc_integration_numba_functions Module¶

Functions¶

`find_inconsistencies`(frame_valid, ...[, ...])	Find, fix (or flag) jumps and return the number corrected per channel.
`fix_jumps`(frame_valid, frame_data, ...[, ...])	Detect and fix jumps in the frame data for each channel.
`fix_block`(from_frame, to_frame, frame_valid, ...)	Jump correct a block of frames for a given channel.
`flag_block`(from_frame, to_frame, ...)	Flag all samples within a block for a given channel with a jump flag.
`level_block`(from_frame, to_frame, ...[, ...])	Level a frame block for a given channel.
`correct_jumps`(frame_data, frame_valid, ...)	Correct DAC jumps in the frame data.
`flag_zeroed_channels`(frame_data, ...)	Flag channels with the DISCARD flag if all frame data are zero valued.
`check_jumps`(start_counter, jump_counter, ...)	Checks for jumps in each channel.

sofia_redux.scan.custom.hawc_plus.scan.scan Module¶

Classes¶

HawcPlusScan(channels[, reduction])

Initialize a HAWC+ scan.

Class Inheritance Diagram¶

sofia_redux.scan.custom.hawc_plus.simulation.simulation Module¶

Classes¶

HawcPlusSimulation(info)

Initialize a HAWC+ simulation.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.channels.camera Module¶

Classes¶

SofiaCamera([name, parent, info, size])

Initialize camera channels.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.channels.channel_data.channel_data Module¶

Classes¶

SofiaChannelData([channels])

Initialize the SOFIA channel data container.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.flags.quality_flags Module¶

Classes¶

QualityFlags()

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.frames.frames Module¶

Classes¶

SofiaFrames()

Initialize frames for SOFIA instruments.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.info Module¶

Classes¶

SofiaInfo([configuration_path])

Initialize a SofiaInfo object.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.sofia_info_numba_functions Module¶

Functions¶

get_drift_corrections(frame_utc, ...)

Get the drift corrections by linear interpolation between drifts.

sofia_redux.scan.custom.sofia.info.aircraft Module¶

Classes¶

SofiaAircraftInfo()

Initialize the SOFIA aircraft information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.astrometry Module¶

Classes¶

SofiaAstrometryInfo()

Initialize astrometry information for SOFIA observations.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.chopping Module¶

Classes¶

SofiaChoppingInfo()

Initialize the SOFIA chopping information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.detector_array Module¶

Classes¶

SofiaDetectorArrayInfo()

Initialize the SOFIA detector array information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.dithering Module¶

Classes¶

SofiaDitheringInfo()

Initialize the SOFIA dithering information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.environment Module¶

Classes¶

SofiaEnvironmentInfo()

Initialize the SOFIA environment information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.extended_scanning Module¶

Classes¶

SofiaExtendedScanningInfo()

Initialize the SOFIA extended scanning information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.gyro_drifts Module¶

Classes¶

`SofiaGyroDriftsInfo`()	Initialize the SOFIA gyro drift information.
`GyroDrift`(header, index)	Initializes a single drift.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.instrument Module¶

Classes¶

SofiaInstrumentInfo()

Initialize the SOFIA instrument information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.mapping Module¶

Classes¶

SofiaMappingInfo()

Initialize the SOFIA mapping information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.mission Module¶

Classes¶

SofiaMissionInfo()

Initialize the SOFIA flight mission information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.mode Module¶

Classes¶

SofiaModeInfo()

Initialize the SOFIA mode information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.nodding Module¶

Classes¶

SofiaNoddingInfo()

Initialize the SOFIA nodding information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.observation Module¶

Classes¶

SofiaObservationInfo()

Initialize the SOFIA observation information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.origination Module¶

Classes¶

SofiaOriginationInfo()

Initialize the SOFIA origination information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.processing Module¶

Classes¶

SofiaProcessingInfo()

Initialize the SOFIA processing information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.scanning Module¶

Classes¶

SofiaScanningInfo()

Initialize the SOFIA scanning information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.spectroscopy Module¶

Classes¶

SofiaSpectroscopyInfo()

Initialize the SOFIA spectroscopy information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.info.telescope Module¶

Classes¶

SofiaTelescopeInfo()

Initialize the SOFIA telescope information.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.integration.integration Module¶

Classes¶

SofiaIntegration([scan])

Initialize a SOFIA integration.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.integration.models.atran Module¶

Classes¶

AtranModel(options)

Initialize the ATRAN model for SOFIA.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.scan.scan Module¶

Classes¶

SofiaScan(channels[, reduction])

Initialize a SOFIA scan.

Class Inheritance Diagram¶

sofia_redux.scan.custom.sofia.simulation.aircraft Module¶

Classes¶

AircraftSimulation()

Initialize a simulated SOFIA aircraft.

Class Inheritance Diagram¶

sofia_redux.scan.filters¶

sofia_redux.scan.filters.filter Module¶

Classes¶

Filter([integration, data])

Initialize an integration filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.filters_numba_functions Module¶

Functions¶

`load_timestream`(frame_data, frame_weights, ...)	Load timestream data from the supplied frame data.
`remove_rejection_from_frames`(frame_data, ...)	Remove the rejected signal from frame data.
`apply_rejection_to_parms`(frame_valid, ...)	Update the frame dependents following the remove operation.
`dft_filter_channels`(frame_data, rejection, ...)	Filter frame data using the filter rejection DFT method.
`dft_filter_frames`(data, rejection, n_frames)	Use DFT to filter single channel data.
`dft_filter_frequency_channel`(data, fch, ...)	Apply DFT filtering for a given frequency channel.
`level_for_channels`(signal, valid_frame, ...)	Level a given signal over all frames for the given channel indices.
`level`(data, n_frames)	Remove the average level from each channel for the provided data set.
`level_1d`(data, n_frames)	Remove the average from a given 1-D data array.
`resample`(old, new)	Fast implementation of the `resample` method.
`accumulate_profiles`(profiles, ...)	Accumulate the calculated profiles onto channel profiles.
`calculate_varied_point_response`(min_fch, ...)	Calculate the point response for the varied filter.
`calculate_channel_point_responses`(min_fch, ...)	Calculate the point response for each given channel of an adaptive filter.
`calc_mean_amplitudes`(amplitudes, ...)	Calculate the mean amplitudes and weights of a Fourier spectrum.
`whiten_profile`(amplitudes, ...)	Fast implementation of the `whiten_profile` method.
`add_frame_parms`(rejected, points, weights, ...)	Add to the frame dependents based on the rejected signal.
`expand_rejection_filter`(reject, half_width, df)	Expand the rejection filter by a given width.
`harmonize_rejection_filter`(reject, ...)	Add harmonics to the rejection filter.

sofia_redux.scan.filters.adaptive_filter Module¶

Classes¶

AdaptiveFilter([integration, data])

Initialize an integration adaptive filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.fixed_filter Module¶

Classes¶

FixedFilter([integration, data])

Initializes a fixed filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.kill_filter Module¶

Classes¶

KillFilter([integration, data])

Initializes a kill filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.motion_filter Module¶

Classes¶

MotionFilter([integration, data])

Initializes a motion filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.multi_filter Module¶

Classes¶

MultiFilter([integration, data])

Initialize an integration multi-filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.varied_filter Module¶

Classes¶

VariedFilter([integration, data])

Initialize an integration varied filter.

Class Inheritance Diagram¶

sofia_redux.scan.filters.whitening_filter Module¶

Classes¶

WhiteningFilter([integration, data])

Initialize an integration whitening filter.

Class Inheritance Diagram¶

sofia_redux.scan.flags¶

sofia_redux.scan.flags.flags Module¶

Classes¶

Flags()

The Flags class contains methods to manipulate flagging.

Class Inheritance Diagram¶

sofia_redux.scan.flags.flag_numba_functions Module¶

Functions¶

`set_flags`(flag_array, flag[, indices])	Add a flag indicator to an array of flags.
`unflag`(flag_array[, flag, indices])	Remove a flag indicator from an array of flags.
`flatten_nd_indices`(indices, array_shape)	Converts ND array indices to flat indices.
`is_flagged`(flag_array[, flag, exact])	Return whether a flag array is flagged with a given flag.
`is_unflagged`(flag_array[, flag, exact])	Return whether a flag array is unflagged by the given flag.
`get_mem_correction`(data, noise[, ...])	Determine the Maximum-Entropy-Method (MEM) correction.
`set_new_blank_value`(data, old_blank, new_blank)	Set all old blanking levels in the data to the new blanking level.

sofia_redux.scan.flags.array_flags Module¶

Classes¶

ArrayFlags()

Class Inheritance Diagram¶

sofia_redux.scan.flags.channel_flags Module¶

Classes¶

ChannelFlags()

Class Inheritance Diagram¶

sofia_redux.scan.flags.flagged_array Module¶

Classes¶

FlaggedArray([data, blanking_value, dtype, ...])

Creates a flagged array instance.

Class Inheritance Diagram¶

sofia_redux.scan.flags.flagged_data Module¶

Classes¶

FlaggedData()

Initialize a FlaggedData object.

Class Inheritance Diagram¶

sofia_redux.scan.flags.flagged_data_group Module¶

Classes¶

FlaggedDataGroup(data[, indices, name])

Create a subgroup of flagged data.

Class Inheritance Diagram¶

sofia_redux.scan.flags.frame_flags Module¶

Classes¶

FrameFlags()

Class Inheritance Diagram¶

sofia_redux.scan.flags.instrument_flags Module¶

Classes¶

InstrumentFlags()

Class Inheritance Diagram¶

sofia_redux.scan.flags.map_flags Module¶

Classes¶

MapFlags()

Class Inheritance Diagram¶

sofia_redux.scan.flags.motion_flags Module¶

Classes¶

MotionFlags(direction)

Initialize a MotionFlags object.

Class Inheritance Diagram¶

sofia_redux.scan.flags.mounts Module¶

Classes¶

Mount(*values)

The Mount class contains all available types of telescope mount.

Class Inheritance Diagram¶

sofia_redux.scan.frames¶

sofia_redux.scan.frames.frames Module¶

Classes¶

Frames()

The Frames class contains all time-dependent data in an integration.

Class Inheritance Diagram¶

sofia_redux.scan.frames.frames_numba_functions Module¶

Functions¶

`add_dependents`(dependents, dp, frame_valid)	Add increments to the frame dependents.
`validate_frames`(valid, cos_a, sin_a, ...)	Checks validity of frame data and updates the angles based on mount type.
`downsample_data`(data, sample_flag, valid, ...)	Downsample data to a new resolution using a window kernel.

sofia_redux.scan.frames.horizontal_frames Module¶

Classes¶

HorizontalFrames()

Initialize horizontal frames.

Class Inheritance Diagram¶

sofia_redux.scan.info¶

sofia_redux.scan.info.info Module¶

Classes¶

Info([configuration_path])

Initialize an Info object.

Class Inheritance Diagram¶

sofia_redux.scan.info.astrometry Module¶

Classes¶

AstrometryInfo()

Initialize the astrometry information.

Class Inheritance Diagram¶

sofia_redux.scan.info.base Module¶

Classes¶

InfoBase()

Initialize a basic informational object.

Class Inheritance Diagram¶

sofia_redux.scan.info.instrument Module¶

Classes¶

InstrumentInfo()

Initialize the instrument information.

Class Inheritance Diagram¶

sofia_redux.scan.info.observation Module¶

Classes¶

ObservationInfo()

Initialize the observation information.

Class Inheritance Diagram¶

sofia_redux.scan.info.origination Module¶

Classes¶

OriginationInfo()

Initialize the origination information.

Class Inheritance Diagram¶

sofia_redux.scan.info.telescope Module¶

Classes¶

TelescopeInfo()

Initialize the telescope information.

Class Inheritance Diagram¶

sofia_redux.scan.info.weather_info Module¶

Classes¶

WeatherInfo([configuration_path])

An abstract class used to retrieve information on environmental conditions such as temperature, pressure, and wind.

Class Inheritance Diagram¶

sofia_redux.scan.integration¶

sofia_redux.scan.integration.integration Module¶

Classes¶

Integration([scan])

Initialize a scan integration.

Class Inheritance Diagram¶

sofia_redux.scan.integration.integration_numba_functions Module¶

Functions¶

`determine_time_weights`(block_size, ...)	Determine the frame weights (noise) in time.
`get_time_weights_by_block`(frame_data, ...[, ...])	Determine the frame weighting (time) for all integration frames.
`robust_channel_weights`(frame_data, ...)	Derive robust channel variance and weights.
`differential_channel_weights`(frame_data, ...)	Derive channel weights using the differential method.
`rms_channel_weights`(frame_data, ...)	Derive channel weights from the RMS of the frame data values.
`set_weights_from_var_stats`(channel_indices, ...)	Set a number of channel data parameters from variance statistics.
`despike_neighbouring`(frame_data, ...)	A Numba function to despike frame samples using neighbour method.
`despike_absolute`(frame_data, sample_flags, ...)	A Numba function to despike frame samples using absolute method.
`despike_gradual`(frame_data, sample_flags, ...)	A Numba function to despike frame samples using gradual method.
`despike_multi_resolution`(timestream_data, ...)	A Numba function to despike frame samples using multi-resolution method.
`flagged_channels_per_frame`(sample_flags, ...)	Return the total number of flagged channels per frame.
`flagged_frames_per_channel`(sample_flags, ...)	Return the total number of flagged frames per channel.
`frame_block_expand_flag`(sample_flags, ...)	If a single frame is flagged in a block, flag all frames in the block.
`next_weight_transit`(frame_weights, level, ...)	Returns the next frame weight transit above or below a given level.
`get_mean_frame_level`(frame_data, ...[, ...])	Return the mean frame values for each channel.
`weighted_mean_frame_level`(frame_data, ...[, ...])	Return the mean frame data values for each channel.
`weighted_median_frame_level`(frame_data, ...)	Return the median frame data values for each channel.
`remove_channel_drifts`(frame_data, ...[, robust])	Calculate and remove the average offset from each channel.
`level`(frame_data, frame_weights, ...)	Subtract an offset per channel from the frame data between given frames.
`apply_drifts_to_channel_data`(...)	Apply the average drifts to channel data.
`detector_stage`(frame_data, frame_valid, ...)	Stage the detector by applying channel hardware gains to the frame data.
`readout_stage`(frame_data, frame_valid, ...)	Unstage the detector by removing channel hardware gains to the frame data.
`search_corners`(sample_coordinates, ...)	Return the x, y range of sample coordinates.
`get_weighted_timestream`(sample_data, ...)	Given sample data and flags, return weighted values, and full weights.
`calculate_2d_velocities`(coordinates, dt)	Calculate the velocities for (x, y) coordinates.
`calculate_2d_accelerations`(coordinates, dt)	Calculate the accelerations for (x, y) coordinates.
`classify_scanning_speeds`(speeds, min_speed, ...)	Classify scanning speeds.
`smooth_positions`(coordinates, bin_size[, ...])	Smooth (x, y) coordinates with a box kernel of given size.
`get_covariance`(frame_data, frame_valid, ...)	Return the channel covariance.
`get_full_covariance_matrix`(covariance, ...)	Return the full covariance in terms of fixed channel indices.
`get_partial_covariance_matrix`(covariance, ...)	Return the covariance matrix for certain channel indices.
`downsample_frame_data`(data, window[, valid])	Downsample data using a supplied kernel.
`downsample_frame_flags`(flags, window[, valid])	Downsample frame flags using a supplied kernel.
`get_downsample_start_indices`(frame_valid, ...)	Down-sample frame data using a given window kernel.
`get_valid_downsampling_frames`(valid_frames, ...)	Return the valid downsampled frames that may be calculated.

sofia_redux.scan.integration.dependents.dependents Module¶

Classes¶

Dependents(integration, name)

Initialize a "dependents" object.

Class Inheritance Diagram¶

sofia_redux.scan.pipeline¶

sofia_redux.scan.pipeline.pipeline Module¶

Classes¶

Pipeline(reduction)

Initialize a reduction pipeline.

Class Inheritance Diagram¶

sofia_redux.scan.reduction¶

sofia_redux.scan.reduction.reduction Module¶

Classes¶

Reduction(instrument[, configuration_file, ...])

Initialize the reduction object.

Class Inheritance Diagram¶

sofia_redux.scan.reduction.version Module¶

Classes¶

ReductionVersion()

Initialize the reduction version information.

Class Inheritance Diagram¶

sofia_redux.scan.scan¶

sofia_redux.scan.scan.scan Module¶

Classes¶

Scan(channels[, reduction])

Initialize a scan.

Class Inheritance Diagram¶

sofia_redux.scan.signal¶

sofia_redux.scan.signal.signal Module¶

Classes¶

Signal(integration[, mode, values, is_floating])

Initialize a Signal object.

Class Inheritance Diagram¶

sofia_redux.scan.signal.signal_numba_functions Module¶

Functions¶

`get_signal_variance`(values[, weights])	Return the signal variance.
`get_ml_correlated`(frame_data, frame_weights, ...)	Derive the maximum-likelihood gain increments and weights.
`get_robust_correlated`(frame_data, ...[, ...])	Derive the robust gain increment and weights.
`resync_gains`(frame_data, signal_values, ...)	Resync the frame data with the signal and gain increments.
`apply_gain_increments`(frame_data, ...)	Apply the gain increments to frame data and signals.
`calculate_filtering`(channel_indices, ...)	Calculate the new signal and channel source filtering.
`differentiate_signal`(values[, dt])	Differentiate the signal values in-place.
`differentiate_weighted_signal`(values, weights)	Differentiate signal values and weights in-place.
`integrate_signal`(values[, dt])	Integrate signal values in-place using the trapezoid rule.
`integrate_weighted_signal`(values, weights[, dt])	Integrate signal values and weights in-place using the trapezoid rule.
`add_drifts`(signal_values, drifts, drift_length)	Add drift values to the signal.
`level`(values, start_frame, end_frame, resolution)	Remove and return the average value between a start and end frame.
`remove_drifts`(signal_values, drifts, ...[, ...])	Remove drifts (average signal levels in a frame block) from the signal.
`get_covariance`(signal_values, frame_data, ...)	Return the signal covariance for samples in frames/channel.
`get_ml_gain_increment`(frame_data, signal_wc, ...)	Return the maximum-likelihood gain increment.
`get_robust_gain_increment`(frame_data, ...)	Return the robust median gain increment.
`synchronize_gains`(frame_data, sample_flags, ...)	Resync the frame data with the gain deltas and update dependents.
`prepare_frame_temp_fields`(signal_values, ...)	Populate some temporary parameters for signal numerical operations.

sofia_redux.scan.signal.correlated_signal Module¶

Classes¶

CorrelatedSignal(integration, mode)

Initialize a correlated signal.

Class Inheritance Diagram¶

sofia_redux.scan.simulation¶

sofia_redux.scan.simulation.info Module¶

Classes¶

SimulationInfo([configuration_path])

Initialize the example instrument simulation information object.

Class Inheritance Diagram¶

sofia_redux.scan.simulation.scan_patterns.constant_speed Module¶

Functions¶

to_constant_speed(pattern)

Convert a pattern such that the samples are equally spaced wrt speed.

sofia_redux.scan.simulation.scan_patterns.daisy Module¶

Functions¶

`daisy_pattern_offset`(radius, radial_period, ...)	Create a daisy scan pattern in offset coordinates.
`daisy_pattern_equatorial`(center, t_interval, ...)	Create a daisy scan pattern in equatorial coordinates.

sofia_redux.scan.simulation.scan_patterns.lissajous Module¶

Functions¶

`lissajous_offset`(width, height, t_interval)	Create a Lissajous scan pattern in offset coordinates.
`lissajous_pattern_equatorial`(center, ...)	Create a Lissajous scan pattern in equatorial coordinates.

sofia_redux.scan.simulation.scan_patterns.skydip Module¶

Functions¶

skydip_pattern_equatorial(center, ...)

Create a skydip observation.

sofia_redux.scan.simulation.source_models.simulated_source Module¶

Classes¶

SimulatedSource()

Initialize a simulated source.

Class Inheritance Diagram¶

sofia_redux.scan.simulation.source_models.single_gaussian Module¶

Classes¶

SingleGaussian(**kwargs)

Initialize a SingleGaussian simulated source.

Class Inheritance Diagram¶

sofia_redux.scan.simulation.source_models.sky Module¶

Classes¶

Sky(**kwargs)

Initialize a simulated sky source.

Class Inheritance Diagram¶

sofia_redux.scan.source_models¶

sofia_redux.scan.source_models.source_model Module¶

Classes¶

SourceModel(info[, reduction])

Initialize a source model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.source_numba_functions Module¶

Functions¶

`calculate_coupling_increment`(map_indices, ...)	Calculate and return the coupling increment factor.
`get_sample_points`(frame_data, frame_gains, ...)	Return the cross-product of frame and channel gains.
`blank_sample_values`(frame, channel_index, ...)	Set bad frame/channel indices to blank values.
`flag_out_of_range_coupling`(channel_indices, ...)	Flags channels with an out-of-range coupling value as "BLIND"
`sync_map_samples`(frame_data, frame_valid, ...)	Remove map source gains from frame data and flag samples.
`get_delta_sync_parms`(channel_source_gains, ...)	Calculate frame/channel dependent deltas following source synchronization.
`flag_outside`(sample_coordinates, ...)	Flag samples outside of the allowed mapping range.
`validate_pixel_indices`(indices, x_size, y_size)	Set pixel indices outside of the map range to (0, 0).
`add_skydip_frames`(data, weight, ...)	Add signal values to the sky dip model data.
`get_source_signal`(frame_data, frame_valid, ...)	Remove map source gains from frame data and flag samples.

sofia_redux.scan.source_models.astro_data_2d Module¶

Classes¶

AstroData2D(info[, reduction])

Initialize an astronomical 2D model of the source data.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.astro_intensity_map Module¶

Classes¶

AstroIntensityMap(info[, reduction])

Initialize an astronomical intensity map.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.astro_model_2d Module¶

Classes¶

AstroModel2D(info[, reduction])

Initialize an astronomical 2D model of the source.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.pixel_map Module¶

Classes¶

PixelMap(info[, reduction])

Initialize a PixelMap source model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.sky_dip Module¶

Classes¶

SkyDip(info[, reduction])

Initialize a skydip model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.sky_dip_model Module¶

Classes¶

SkyDipModel()

Initialize a sky dip model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.beams.asymmetry_2d Module¶

Classes¶

Asymmetry2D([x, y, x_weight, y_weight])

Initialize an Asymmetry2D object.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.beams.elliptical_source Module¶

Classes¶

EllipticalSource([peak, x_mean, y_mean, ...])

Initialize an EllipticalSource model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.beams.gaussian_2d Module¶

Classes¶

Gaussian2D([peak, x_mean, y_mean, x_fwhm, ...])

Initializes a 2-D Gaussian beam model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.beams.gaussian_source Module¶

Classes¶

GaussianSource([peak, x_mean, y_mean, ...])

Initialize a GaussianSource model.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.beams.instant_focus Module¶

Classes¶

InstantFocus()

Initialize an InstantFocus object.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.fits_properties.fits_properties Module¶

Classes¶

FitsProperties()

Initialize a FITS properties object.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.exposure_map Module¶

Classes¶

ExposureMap([observation])

Create an exposure map overlay of an observation.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.fits_data Module¶

Classes¶

FitsData([data, blanking_value, dtype, ...])

Creates a FitsData instance.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.image Module¶

Classes¶

Image([data, blanking_value, dtype, shape, unit])

Creates an Image instance.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.image_2d Module¶

Classes¶

Image2D([x_size, y_size, dtype, data, ...])

Create an Image2D instance.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.map_2d Module¶

Classes¶

Map2D([data, blanking_value, dtype, shape, unit])

Initialize a Map2D instance.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.noise_map Module¶

Classes¶

NoiseMap([observation])

Create a noise map overlay of an observation.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.observation_2d Module¶

Classes¶

Observation2D([data, blanking_value, dtype, ...])

Initialize an Observation2D object.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.overlay Module¶

Classes¶

Overlay([data, blanking_value, dtype, ...])

Create an overlay of an underlying image.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.significance_map Module¶

Classes¶

SignificanceMap([observation])

Create a significance map overlay of an observation.

Class Inheritance Diagram¶

sofia_redux.scan.source_models.maps.weight_map Module¶

Classes¶

WeightMap([observation])

Create a weight map overlay of an observation.

Class Inheritance Diagram¶

sofia_redux.scan.utilities¶

sofia_redux.scan.utilities.utils Module¶

Functions¶

`get_string`(value[, default])	Return a string representation of the given value.
`get_bool`(value[, default])	Return a bool representation of the given value.
`get_int`(value[, default])	Return an integer representation of the given value.
`get_float`(value[, default])	Return a float representation of the given value.
`get_range`(value[, default, is_positive])	Return a Range object generated from the given value.
`get_list`(value)	Resolve the given value into a list.
`get_string_list`(value[, delimiter, default])	Return a list of strings from the given single string.
`get_float_list`(value[, delimiter, default])	Return a list of floats from a single string.
`get_int_list`(value[, delimiter, default, ...])	Return a list of ints from a single string.
`to_int_list`(values[, is_positive])	Convert all elements in a list to integers.
`parse_time`(hms_string[, angle])	Returns H:M:S string as time Quantity.
`parse_angle`(dms)	Convert a degree:minute:second string into an angle.
`get_dms_angle`(value[, default])	Return a degree angle quantity from a given value.
`get_hms_time`(value[, angle, default])	Return a time or hour angle quantity from a given value.
`get_sign`(value[, default])	Return an integer representation of a sign.
`get_epoch`(equinox)	Return an astropy frame representing the equinox of an observation.
`valid_value`(value)	Return if a given value is valid in the context of unknown values.
`robust_mean`(array[, tails])	Performs a mean calculation with optional tails.
`robust_sigma_clip_mask`(values[, weights, ...])	Return a masking array indicating sigma clipped elements of an input array.
`roundup_ratio`(a, b)	Returns int((a + b - 1) / b).
`rotate`(positions, angle)	Rotate 2 dimensional coordinates by a given angle.
`log2round`(x)	Returns the rounded value of log_2(x).
`pow2round`(x)	Returns the value rounded to the closest 2^N integer.
`pow2floor`(x)	Returns the value floored to the closest 2^N integer.
`pow2ceil`(x)	Returns the value ceiled to the closest 2^N integer.
`skycoord_insert_blanks`(coordinates, ...)	Insert zeroed coordinates in an astropy coordinate frame.
`dict_intersection`(options1, options2[, ...])	Return the intersection of two dictionaries.
`dict_difference`(options1, options2[, ...])	Return the difference of two dictionaries.
`to_header_quantity`(value[, unit, keep])	Convert a value to a Quantity suitable for header entry.
`to_header_float`(value[, unit])	Parse a value to a parsable header float value.
`combine_beams`(beam1, beam2[, deconvolve])	Convolve or deconvolve one beam by another.
`convolve_beam`(beam1, beam2)	Convolve one beam by another.
`deconvolve_beam`(beam1, beam2)	Deconvolve one beam by another.
`encompass_beam`(beam1, beam2)	Encompass one beam by another.
`encompass_beam_fwhm`(beam, fwhm)	Encompass one beam by a given fwhm.
`get_beam_area`(psf)	Return the area of a 2-dimensional Gaussian model.
`get_header_quantity`(header, key[, default, ...])	Get an astropy quantity from a FITS header value.
`ascii_file_to_frame_data`(ascii_file)	Convert time stream data from a ascii file to a numpy array.
`insert_into_header`(header, key, value[, ...])	Insert a key, value into the header at a specific location.
`insert_info_in_header`(header, header_info[, ...])	Insert header information into a header at a given location.
`to_header_cards`(header_info)	Convert header-like information to a list of cards.
`clear_numba_cache`()	Aggressively remove the numba cache for the sofia_scan package.
`round_values`(x)	Round any given value to the expected result.
`get_comment_unit`(comment[, default])	See if a header comment contains a unit and return if found.
`safe_sidereal_time`(t, kind[, longitude, model])	Calculate sidereal time, even if offline.

sofia_redux.scan.utilities.numba_functions Module¶

Functions¶

`smart_median_1d`(values[, weights, ...])	Returns the weighted median of values in one dimension.
`smart_median_2d`(values[, weights, ...])	Returns the weighted median of values in two dimensions.
`smart_median`(values[, weights, axis, ...])	Returns the weighted median of values in K-dimensions.
`roundup_ratio`(a, b)	Returns int((a + b - 1) / b).
`level`(values[, start, end, resolution])	Subtract the average value from all values and return the average.
`smooth_1d`(values, kernel)	Apply 1-D kernel convolution in place.
`gaussian_kernel`(n, sigma)	Create a Gaussian convolution kernel.
`mean`(values[, weights, start, end])	Return the (optionally weighted) mean value of an array.
`box_smooth_along_zero_axis`(values, bin_size)	Smooth a 2-D array of values along the zeroth axis.
`log2round`(x)	Return the rounded value of log_2(x).
`log2ceil`(x)	Return the ceiled value of log_2(x).
`pow2round`(x)	Return 2 to the power of round(log_2(x)).
`pow2floor`(x)	Return 2 to the power of floor(log_2(x)).
`pow2ceil`(x)	Return 2 to the power of ceil(log_2(x)).
`regular_kernel_convolve`(data, kernel[, ...])	Direct convolution of ND data with a given kernel.
`regular_coarse_kernel_convolve`(data, kernel, ...)	Direct convolution of ND data with a given kernel onto a coarse grid.
`smooth_values_at`(data, kernel, indices, ...)	Return the values of data, smoothed by a kernel at the given indices.
`smooth_value_at`(data, kernel, index, ...)	Return the convolution of data with a kernel at a single point.
`point_aligned_smooth`(flat_data, flat_kernel, ...)	Perform direct kernel convolution at a single point.
`point_smooth`(flat_data, index, ...)	Convolution with a spline representation of a kernel at a single point.
`sequential_array_add`(array, add_values, ...)	Add one array of values to another.
`index_of_max`(array[, valid, sign])	Return the maximum value and index of that value.
`robust_mean`(values[, tails])	Calculate the robust mean value excluding tails.

sofia_redux.scan.utilities.bracketed_values Module¶

Classes¶

BracketedValues([start, end, unit])

Initialize a BracketedValues object.

Class Inheritance Diagram¶

sofia_redux.scan.utilities.class_provider Module¶

Functions¶

`fix_instrument_name`(name)	Return a valid name for the given instrument.
`get_instrument_module_path`(instrument)	Return the module path to custom SOFSCAN instrument
`to_class_name`(name)	Return the associated class type name for a given string.
`to_module_name`(class_name)	Convert a class name to the base module it may be found in.
`get_instrument_path_and_class_name`(instrument)	Get the module path and class name prefix for a given instrument name.
`get_class_for`(instrument, module_path_name)	Return an instrument specific class for a given module.
`channel_class_for`(instrument)	Returns a Channels instance for a given instrument.
`channel_data_class_for`(instrument)	Returns a ChannelData instance for a given instrument.
`channel_group_class_for`(instrument)	Returns the appropriate ChannelGroup class for a given instrument.
`frames_class_for`(instrument)	Returns the appropriate ChannelGroup class for a given instrument.
`frames_instance_for`(instrument)	Return a Frames instance for a given instrument.
`info_class_for`(instrument)	Return an Info instance given an instrument name.
`get_integration_class`(instrument)	Return an Integration instance given an instrument name.
`get_scan_class`(instrument)	Return the appropriate scan class for an instrument name.
`default_modality_mode`(modality)	Return a default mode class based on modality class.
`get_grid_class`(name)	Returns a Grid class of the given name
`get_projection_class`(name)	Returns a Projection class of the given name
`get_simulated_source_class`(name)	Return a simulated source of the given name.

sofia_redux.scan.utilities.range Module¶

Classes¶

Range([min_val, max_val, include_min, ...])

Initialize a Range object.

Navigation

sofia_redux.scan: Scan Mode Algorithms for SOFIA Pipelines¶

Description¶

Architecture¶

Usage¶

Reference/API¶

sofia_redux.scan.channels¶

sofia_redux.scan.channels.channels Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_numba_functions Module¶

Functions¶

sofia_redux.scan.channels.camera.camera Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.camera.color_arrangement Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.camera.single_color_arrangement Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.channel_data Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.color_arrangement_data Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_data.single_color_channel_data Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.channel_group.channel_group Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.division.division Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.gain_provider Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.field_gain_provider Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.sky_gradient Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.gain_provider.zero_mean_gains Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.modality Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.correlated_modality Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.coupled_modality Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.modality.non_linear_modality Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.mode Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.response Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.acceleration_response Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.chopper_response Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.correlated_mode Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.field_response Module¶

Classes¶

Class Inheritance Diagram¶

sofia_redux.scan.channels.mode.motion_response Module¶

Classes¶