#include <Frame.h>

Collaboration diagram for SourceXtractor::Frame< T >:

[legend]

Classes
class	ImageFilter

Public Member Functions
	Frame (std::shared_ptr< Image< T > > detection_image, std::shared_ptr< WeightImage > variance_map, WeightImage::PixelType variance_threshold, std::shared_ptr< CoordinateSystem > coordinate_system, SeFloat gain, SeFloat saturation, int interpolation_gap)
	Frame (std::shared_ptr< Image< T > > detection_image, std::shared_ptr< CoordinateSystem > coordinate_system=nullptr, std::shared_ptr< WeightImage > variance_map=nullptr)
std::shared_ptr< Image< T > >	getImage (FrameImageLayer layer) const
std::shared_ptr< Image< T > >	getOriginalImage () const
size_t	getHduIndex () const
void	setHduIndex (size_t hdu_index)
const std::map< std::string, MetadataEntry > &	getMetadata () const
void	setMetadata (const std::map< std::string, MetadataEntry > &metadata)
std::shared_ptr< Image< T > >	getInterpolatedImage () const
std::shared_ptr< Image< T > >	getSubtractedImage () const
std::shared_ptr< Image< T > >	getFilteredImage () const
std::shared_ptr< Image< T > >	getThresholdedImage () const
std::shared_ptr< Image< T > >	getSnrImage () const
std::shared_ptr< WeightImage >	getVarianceMap () const
std::shared_ptr< WeightImage >	getUnfilteredVarianceMap () const
std::shared_ptr< WeightImage >	getOriginalVarianceMap () const
std::shared_ptr< CoordinateSystem >	getCoordinateSystem () const
WeightImage::PixelType	getVarianceThreshold () const
SeFloat	getGain () const
SeFloat	getSaturation () const
SeFloat	getBackgroundMedianRms () const
std::shared_ptr< Image< T > >	getDetectionThresholdMap () const
std::string	getLabel () const
void	setVarianceMap (std::shared_ptr< WeightImage > variance_map)
void	setVarianceThreshold (WeightImage::PixelType threshold)
std::shared_ptr< Image< T > >	getBackgroundLevelMap () const
void	setDetectionThreshold (T detection_threshold)
void	setBackgroundLevel (T background_level)
void	setBackgroundLevel (std::shared_ptr< Image< T > > background_level_map, T background_rms)
void	setFilter (std::shared_ptr< ImageFilter > filter)
void	setLabel (const std::string &label)

Private Member Functions
void	applyFilter ()
void	applyInterpolation ()

Private Attributes
std::shared_ptr< Image< T > >	m_image
std::shared_ptr< WeightImage >	m_variance_map
std::shared_ptr< Image< T > >	m_background_level_map
std::shared_ptr< CoordinateSystem >	m_coordinate_system
SeFloat	m_gain
SeFloat	m_saturation
SeFloat	m_background_rms
T	m_detection_threshold
WeightImage::PixelType	m_variance_threshold
int	m_interpolation_gap
std::shared_ptr< ImageFilter >	m_filter
std::shared_ptr< Image< T > >	m_interpolated_image
std::shared_ptr< Image< WeightImage::PixelType > >	m_interpolated_variance
std::shared_ptr< Image< T > >	m_filtered_image
std::shared_ptr< Image< T > >	m_filtered_variance_map
std::string	m_label
size_t	m_hdu_index = 0
std::map< std::string, MetadataEntry >	m_metadata {}

Detailed Description

template<typename T>
class SourceXtractor::Frame< T >

Definition at line 50 of file Frame.h.

Constructor & Destructor Documentation

◆ Frame() [1/2]

template<typename T>

SourceXtractor::Frame< T >::Frame	(	std::shared_ptr< Image< T > >	detection_image,
		std::shared_ptr< WeightImage >	variance_map,
		WeightImage::PixelType	variance_threshold,
		std::shared_ptr< CoordinateSystem >	coordinate_system,
		SeFloat	gain,
		SeFloat	saturation,
		int	interpolation_gap )

Definition at line 31 of file Frame.cpp.

References applyFilter(), applyInterpolation(), m_background_rms, m_coordinate_system, m_detection_threshold, m_gain, m_image, m_interpolation_gap, m_saturation, m_variance_map, and m_variance_threshold.

Here is the call graph for this function:

◆ Frame() [2/2]

template<typename T>

SourceXtractor::Frame< T >::Frame	(	std::shared_ptr< Image< T > >	detection_image,
		std::shared_ptr< CoordinateSystem >	coordinate_system = nullptr,
		std::shared_ptr< WeightImage >	variance_map = nullptr )

explicit

Definition at line 52 of file Frame.cpp.

References applyFilter(), applyInterpolation(), SourceXtractor::ConstantImage< T >::create(), m_background_rms, m_coordinate_system, m_detection_threshold, m_gain, m_image, m_interpolation_gap, m_saturation, m_variance_map, and m_variance_threshold.

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

template<typename T>

void SourceXtractor::Frame< T >::applyFilter ( )

private

Definition at line 262 of file Frame.cpp.

References SourceXtractor::FunctionalImage< T, I >::create(), getSubtractedImage(), getUnfilteredVarianceMap(), m_filter, m_filtered_image, m_filtered_variance_map, m_variance_threshold, and std::max().

Referenced by Frame(), Frame(), setBackgroundLevel(), setFilter(), setVarianceMap(), and setVarianceThreshold().

Here is the call graph for this function:

◆ applyInterpolation()

template<typename T>

void SourceXtractor::Frame< T >::applyInterpolation ( )

private

Definition at line 282 of file Frame.cpp.

References SourceXtractor::BufferedImage< T >::create(), m_image, m_interpolated_image, m_interpolated_variance, m_interpolation_gap, m_variance_map, m_variance_threshold, and std::make_shared().

Referenced by Frame(), Frame(), setVarianceMap(), and setVarianceThreshold().

Here is the call graph for this function:

◆ getBackgroundLevelMap()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getBackgroundLevelMap ( ) const

Definition at line 212 of file Frame.cpp.

References SourceXtractor::ConstantImage< T >::create(), m_background_level_map, and m_image.

Referenced by getSubtractedImage().

Here is the call graph for this function:

◆ getBackgroundMedianRms()

template<typename T>

SeFloat SourceXtractor::Frame< T >::getBackgroundMedianRms ( ) const

inline

Definition at line 147 of file Frame.h.

◆ getCoordinateSystem()

template<typename T>

std::shared_ptr< CoordinateSystem > SourceXtractor::Frame< T >::getCoordinateSystem ( ) const

inline

Definition at line 131 of file Frame.h.

◆ getDetectionThresholdMap()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getDetectionThresholdMap ( ) const

Definition at line 164 of file Frame.cpp.

References m_detection_threshold, m_variance_map, and std::sqrt().

Referenced by getImage().

Here is the call graph for this function:

◆ getFilteredImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getFilteredImage ( ) const

Definition at line 129 of file Frame.cpp.

References m_filtered_image.

Referenced by getImage(), getSnrImage(), and getThresholdedImage().

◆ getGain()

template<typename T>

SeFloat SourceXtractor::Frame< T >::getGain ( ) const

inline

Definition at line 139 of file Frame.h.

◆ getHduIndex()

template<typename T>

size_t SourceXtractor::Frame< T >::getHduIndex ( ) const

inline

Definition at line 83 of file Frame.h.

◆ getImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getImage ( FrameImageLayer layer ) const

◆ getInterpolatedImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getInterpolatedImage ( ) const

Definition at line 112 of file Frame.cpp.

References m_image, and m_interpolated_image.

Referenced by getImage(), and getSubtractedImage().

◆ getLabel()

template<typename T>

std::string SourceXtractor::Frame< T >::getLabel ( ) const

inline

Definition at line 153 of file Frame.h.

◆ getMetadata()

template<typename T>

const std::map< std::string, MetadataEntry > & SourceXtractor::Frame< T >::getMetadata ( ) const

inline

Definition at line 92 of file Frame.h.

◆ getOriginalImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getOriginalImage ( ) const

inline

Definition at line 79 of file Frame.h.

Referenced by getImage().

◆ getOriginalVarianceMap()

template<typename T>

std::shared_ptr< WeightImage > SourceXtractor::Frame< T >::getOriginalVarianceMap ( ) const

inline

Definition at line 123 of file Frame.h.

Referenced by getImage().

◆ getSaturation()

template<typename T>

SeFloat SourceXtractor::Frame< T >::getSaturation ( ) const

inline

Definition at line 143 of file Frame.h.

◆ getSnrImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getSnrImage ( ) const

Definition at line 141 of file Frame.cpp.

References SourceXtractor::ProcessedImage< T, SnrOperation< T > >::create(), getFilteredImage(), and getVarianceMap().

Referenced by getImage().

Here is the call graph for this function:

◆ getSubtractedImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getSubtractedImage ( ) const

Definition at line 123 of file Frame.cpp.

References SourceXtractor::ProcessedImage< T, SubtractOperation< T > >::create(), getBackgroundLevelMap(), and getInterpolatedImage().

Referenced by applyFilter(), and getImage().

Here is the call graph for this function:

◆ getThresholdedImage()

template<typename T>

std::shared_ptr< Image< T > > SourceXtractor::Frame< T >::getThresholdedImage ( ) const

Definition at line 135 of file Frame.cpp.

References SourceXtractor::ThresholdedImage< T >::create(), getFilteredImage(), getVarianceMap(), and m_detection_threshold.

Referenced by getImage().

Here is the call graph for this function:

◆ getUnfilteredVarianceMap()

template<typename T>

std::shared_ptr< WeightImage > SourceXtractor::Frame< T >::getUnfilteredVarianceMap ( ) const

Definition at line 153 of file Frame.cpp.

References m_interpolated_variance, and m_variance_map.

Referenced by applyFilter(), and getImage().

◆ getVarianceMap()

template<typename T>

std::shared_ptr< WeightImage > SourceXtractor::Frame< T >::getVarianceMap ( ) const

Definition at line 147 of file Frame.cpp.

References m_filtered_variance_map.

Referenced by getImage(), getSnrImage(), and getThresholdedImage().

◆ getVarianceThreshold()

template<typename T>

WeightImage::PixelType SourceXtractor::Frame< T >::getVarianceThreshold ( ) const

inline

Definition at line 135 of file Frame.h.

◆ setBackgroundLevel() [1/2]

template<typename T>

void SourceXtractor::Frame< T >::setBackgroundLevel	(	std::shared_ptr< Image< T > >	background_level_map,
		T	background_rms )

Definition at line 236 of file Frame.cpp.

References applyFilter(), m_background_level_map, m_background_rms, m_filtered_image, and m_filtered_variance_map.

Here is the call graph for this function:

◆ setBackgroundLevel() [2/2]

template<typename T>

void SourceXtractor::Frame< T >::setBackgroundLevel ( T background_level )

Definition at line 230 of file Frame.cpp.

References SourceXtractor::ConstantImage< T >::create(), m_image, and setBackgroundLevel().

Referenced by setBackgroundLevel().

Here is the call graph for this function:

◆ setDetectionThreshold()

template<typename T>

void SourceXtractor::Frame< T >::setDetectionThreshold ( T detection_threshold )

Definition at line 224 of file Frame.cpp.

References m_detection_threshold.

◆ setFilter()

template<typename T>

void SourceXtractor::Frame< T >::setFilter ( std::shared_ptr< ImageFilter > filter )

Definition at line 247 of file Frame.cpp.

References applyFilter(), m_filter, m_filtered_image, and m_filtered_variance_map.

Here is the call graph for this function:

◆ setHduIndex()

template<typename T>

void SourceXtractor::Frame< T >::setHduIndex ( size_t hdu_index )

inline

Definition at line 87 of file Frame.h.

◆ setLabel()

template<typename T>

void SourceXtractor::Frame< T >::setLabel ( const std::string & label )

Definition at line 256 of file Frame.cpp.

References m_label.

◆ setMetadata()

template<typename T>

void SourceXtractor::Frame< T >::setMetadata ( const std::map< std::string, MetadataEntry > & metadata )

inline

Definition at line 96 of file Frame.h.

◆ setVarianceMap()

template<typename T>

void SourceXtractor::Frame< T >::setVarianceMap ( std::shared_ptr< WeightImage > variance_map )

Definition at line 175 of file Frame.cpp.

References applyFilter(), applyInterpolation(), m_filtered_image, m_filtered_variance_map, m_interpolated_image, m_interpolated_variance, and m_variance_map.

Here is the call graph for this function:

◆ setVarianceThreshold()

template<typename T>

void SourceXtractor::Frame< T >::setVarianceThreshold ( WeightImage::PixelType threshold )

Definition at line 190 of file Frame.cpp.

References applyFilter(), applyInterpolation(), m_filtered_image, m_filtered_variance_map, m_interpolated_image, m_interpolated_variance, m_variance_threshold, and std::numeric_limits::max().

Here is the call graph for this function:

Member Data Documentation

◆ m_background_level_map

template<typename T>

std::shared_ptr<Image<T> > SourceXtractor::Frame< T >::m_background_level_map

private

Definition at line 184 of file Frame.h.

Referenced by getBackgroundLevelMap(), and setBackgroundLevel().

◆ m_background_rms

template<typename T>

SeFloat SourceXtractor::Frame< T >::m_background_rms

private

Definition at line 190 of file Frame.h.

Referenced by Frame(), Frame(), and setBackgroundLevel().

◆ m_coordinate_system

template<typename T>

std::shared_ptr<CoordinateSystem> SourceXtractor::Frame< T >::m_coordinate_system

private

Definition at line 186 of file Frame.h.

Referenced by Frame(), and Frame().

◆ m_detection_threshold

template<typename T>

T SourceXtractor::Frame< T >::m_detection_threshold

private

Definition at line 192 of file Frame.h.

Referenced by Frame(), Frame(), getDetectionThresholdMap(), getThresholdedImage(), and setDetectionThreshold().

◆ m_filter

template<typename T>

std::shared_ptr<ImageFilter> SourceXtractor::Frame< T >::m_filter

private

Definition at line 197 of file Frame.h.

Referenced by applyFilter(), and setFilter().

◆ m_filtered_image

template<typename T>

std::shared_ptr<Image<T> > SourceXtractor::Frame< T >::m_filtered_image

private

Definition at line 200 of file Frame.h.

Referenced by applyFilter(), getFilteredImage(), setBackgroundLevel(), setFilter(), setVarianceMap(), and setVarianceThreshold().

◆ m_filtered_variance_map

template<typename T>

std::shared_ptr<Image<T> > SourceXtractor::Frame< T >::m_filtered_variance_map

private

Definition at line 201 of file Frame.h.

Referenced by applyFilter(), getVarianceMap(), setBackgroundLevel(), setFilter(), setVarianceMap(), and setVarianceThreshold().

◆ m_gain

template<typename T>

SeFloat SourceXtractor::Frame< T >::m_gain

private

Definition at line 188 of file Frame.h.

Referenced by Frame(), and Frame().

◆ m_hdu_index

template<typename T>

size_t SourceXtractor::Frame< T >::m_hdu_index = 0

private

Definition at line 204 of file Frame.h.

◆ m_image

template<typename T>

std::shared_ptr<Image<T> > SourceXtractor::Frame< T >::m_image

private

Definition at line 182 of file Frame.h.

Referenced by applyInterpolation(), Frame(), Frame(), getBackgroundLevelMap(), getInterpolatedImage(), and setBackgroundLevel().

◆ m_interpolated_image

template<typename T>

std::shared_ptr<Image<T> > SourceXtractor::Frame< T >::m_interpolated_image

private

Definition at line 198 of file Frame.h.

Referenced by applyInterpolation(), getInterpolatedImage(), setVarianceMap(), and setVarianceThreshold().

◆ m_interpolated_variance

template<typename T>

std::shared_ptr<Image<WeightImage::PixelType> > SourceXtractor::Frame< T >::m_interpolated_variance

private

Definition at line 199 of file Frame.h.

Referenced by applyInterpolation(), getUnfilteredVarianceMap(), setVarianceMap(), and setVarianceThreshold().

◆ m_interpolation_gap

template<typename T>

int SourceXtractor::Frame< T >::m_interpolation_gap

private

Definition at line 195 of file Frame.h.

Referenced by applyInterpolation(), Frame(), and Frame().

◆ m_label

template<typename T>

std::string SourceXtractor::Frame< T >::m_label

private

Definition at line 203 of file Frame.h.

Referenced by setLabel().

◆ m_metadata

template<typename T>

std::map<std::string, MetadataEntry> SourceXtractor::Frame< T >::m_metadata {}

private

Definition at line 205 of file Frame.h.

◆ m_saturation

template<typename T>

SeFloat SourceXtractor::Frame< T >::m_saturation

private

Definition at line 189 of file Frame.h.

Referenced by Frame(), and Frame().

◆ m_variance_map

template<typename T>

std::shared_ptr<WeightImage> SourceXtractor::Frame< T >::m_variance_map

private

Definition at line 183 of file Frame.h.

Referenced by applyInterpolation(), Frame(), Frame(), getDetectionThresholdMap(), getUnfilteredVarianceMap(), and setVarianceMap().

◆ m_variance_threshold

template<typename T>

WeightImage::PixelType SourceXtractor::Frame< T >::m_variance_threshold

private

Definition at line 193 of file Frame.h.

Referenced by applyFilter(), applyInterpolation(), Frame(), Frame(), and setVarianceThreshold().

The documentation for this class was generated from the following files:

SEFramework/SEFramework/Frame/Frame.h
SEFramework/src/lib/Frame/Frame.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Frame() [1/2]

◆ Frame() [2/2]

Member Function Documentation

◆ applyFilter()

◆ applyInterpolation()

◆ getBackgroundLevelMap()

◆ getBackgroundMedianRms()

◆ getCoordinateSystem()

◆ getDetectionThresholdMap()

◆ getFilteredImage()

◆ getGain()

◆ getHduIndex()

◆ getImage()

◆ getInterpolatedImage()

◆ getLabel()

◆ getMetadata()

◆ getOriginalImage()

◆ getOriginalVarianceMap()

◆ getSaturation()

◆ getSnrImage()

◆ getSubtractedImage()

◆ getThresholdedImage()

◆ getUnfilteredVarianceMap()

◆ getVarianceMap()

◆ getVarianceThreshold()

◆ setBackgroundLevel() [1/2]

◆ setBackgroundLevel() [2/2]

◆ setDetectionThreshold()

◆ setFilter()

◆ setHduIndex()

◆ setLabel()

◆ setMetadata()

◆ setVarianceMap()

◆ setVarianceThreshold()

Member Data Documentation

◆ m_background_level_map

◆ m_background_rms

◆ m_coordinate_system

◆ m_detection_threshold

◆ m_filter

◆ m_filtered_image

◆ m_filtered_variance_map

◆ m_gain

◆ m_hdu_index

◆ m_image

◆ m_interpolated_image

◆ m_interpolated_variance

◆ m_interpolation_gap

◆ m_label

◆ m_metadata

◆ m_saturation

◆ m_variance_map

◆ m_variance_threshold