ColorArrangementData

class sofia_redux.scan.channels.channel_data.color_arrangement_data.ColorArrangementData(channels=None)[source]

Bases: ChannelData

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

Initialize channel data.

The channel data is a FlaggedData collection containing parameters relating to each individual channel (pixel or detector) of a given instrument.

Parameters:
channelssofia_redux.scan.channels.channels.Channels

Methods Summary

apply_info(info)

Apply information to the channel data.

get_mapping_pixels([indices, name, ...])

Creates and returns mapping pixels.

get_pixel_count()

Return the number of pixels in the channels.

get_pixels()

Return the pixels in the arrangement.

set_beam_size(beam_size)

Sets the resolution of the channels to a specified beam size.

Methods Documentation

apply_info(info)[source]

Apply information to the channel data.

Parameters:
infoInfo
Returns:
None
abstract get_mapping_pixels(indices=None, name=None, keep_flag=None, discard_flag=None, match_flag=None)[source]

Creates and returns mapping pixels.

Parameters:
indicesnumpy.ndarray (int), optional

The indices to reference. If not supplied, defaults to all channels.

namestr, optional

The name of the channel group. If not supplied, defaults to the name of the channel data.

discard_flagint or str or ChannelFlagTypes, optional

Flags to discard_flag from the new group.

keep_flagint or str or ChannelFlagTypes, optional

Keep channels with these matching flags.

match_flagint or str or ChannelFlagTypes, optional

Keep only channels with a flag exactly matching this flag.

Returns:
ChannelGroup

A newly created channel group.

abstract get_pixel_count()[source]

Return the number of pixels in the channels.

Returns:
pixelsint
abstract get_pixels()[source]

Return the pixels in the arrangement.

Returns:
ChannelData
set_beam_size(beam_size)[source]

Sets the resolution of the channels to a specified beam size.

Parameters:
beam_sizeastropy.units.Quantity
Returns:
None