lost::GeneratedPipelineInput Class Reference

A pipeline input which is generated (fake image). More...

#include <io.hpp>

Inheritance diagram for lost::GeneratedPipelineInput:

Collaboration diagram for lost::GeneratedPipelineInput:

Public Member Functions
	GeneratedPipelineInput (const Catalog &, Attitude, Camera, std::default_random_engine *, bool centroidsOnly, decimal observedReferenceBrightness, decimal starSpreadStdDev, decimal sensitivity, decimal darkCurrent, decimal readNoiseStdDev, Attitude motionBlurDirection, decimal exposureTime, decimal readoutTime, bool shotNoise, int oversampling, int numFalseStars, int falseMinMagnitude, int falseMaxMagnitude, int cutoffMag, decimal perturbationStddev)
	Create a generated pipeline input.
const Image *	InputImage () const override
const Stars *	InputStars () const override
const Stars *	ExpectedStars () const override
const Camera *	InputCamera () const override
const StarIdentifiers *	InputStarIds () const override
	The centroid indices in the StarIdentifiers returned from InputStarIds should be indices into InputStars(), not ExpectedStars(), when present, because otherwise it's useless.
const StarIdentifiers *	ExpectedStarIds () const override
	Centroid indices in the StarIdentifiers returned from ExpectedStarIds should be indices into ExpectedStars(), /not/ InputStars().
const Attitude *	InputAttitude () const override
	Only used in tracking mode, in which case it is an estimate of the current attitude based on the last attitude, IMU info, etc.
const Catalog &	GetCatalog () const override
	The catalog to which catalog indexes returned from other methods refer.
Public Member Functions inherited from lost::PipelineInput
virtual	~PipelineInput ()
cairo_surface_t *	InputImageSurface () const
	Convert the InputImage() output into a cairo surface.
virtual const Attitude *	ExpectedAttitude () const

Detailed Description

A pipeline input which is generated (fake image).

Uses a pretty decent image generation algorithm to create a fake image as the basis for a pipeline input. Since we know everything about the generated image, all of the input and expected methods are available.

Definition at line 125 of file io.hpp.

Constructor & Destructor Documentation

GeneratedPipelineInput()

lost::GeneratedPipelineInput::GeneratedPipelineInput	(	const Catalog &	catalog,
		Attitude	attitude,
		Camera	camera,
		std::default_random_engine *	rng,
		bool	centroidsOnly,
		decimal	zeroMagTotalPhotons,
		decimal	starSpreadStdDev,
		decimal	saturationPhotons,
		decimal	darkCurrent,
		decimal	readNoiseStdDev,
		Attitude	motionBlurDirection,
		decimal	exposureTime,
		decimal	readoutTime,
		bool	shotNoise,
		int	oversampling,
		int	numFalseStars,
		int	falseStarMinMagnitude,
		int	falseStarMaxMagnitude,
		int	cutoffMag,
		decimal	perturbationStddev
	)

Create a generated pipeline input.

The parameters correspond directly to command line options. See the command line documentation for more details. This constructor performs the actual image generation.

Definition at line 485 of file io.cpp.

Here is the call graph for this function:

Member Function Documentation

ExpectedStarIds()

const StarIdentifiers * lost::GeneratedPipelineInput::ExpectedStarIds ( ) const

inlineoverridevirtual

Centroid indices in the StarIdentifiers returned from ExpectedStarIds should be indices into ExpectedStars(), /not/ InputStars().

This is in contrast to InputStarIds. If you need to compare ExpectedStarIds against the input stars, then you should use some function which uses simple heuristics to match the input stars and expected stars (eg based on distance). Cf how the star-ID comparator works for a reference implementation.

Reimplemented from lost::PipelineInput.

Definition at line 144 of file io.hpp.

ExpectedStars()

const Stars * lost::GeneratedPipelineInput::ExpectedStars ( ) const

inlineoverridevirtual

Reimplemented from lost::PipelineInput.

Definition at line 141 of file io.hpp.

GetCatalog()

const Catalog & lost::GeneratedPipelineInput::GetCatalog ( ) const

inlineoverridevirtual

The catalog to which catalog indexes returned from other methods refer.

Implements lost::PipelineInput.

Definition at line 146 of file io.hpp.

InputAttitude()

const Attitude * lost::GeneratedPipelineInput::InputAttitude ( ) const

inlineoverridevirtual

Only used in tracking mode, in which case it is an estimate of the current attitude based on the last attitude, IMU info, etc.

Reimplemented from lost::PipelineInput.

Definition at line 145 of file io.hpp.

InputCamera()

const Camera * lost::GeneratedPipelineInput::InputCamera ( ) const

inlineoverridevirtual

Reimplemented from lost::PipelineInput.

Definition at line 142 of file io.hpp.

InputImage()

const Image * lost::GeneratedPipelineInput::InputImage ( ) const

inlineoverridevirtual

Reimplemented from lost::PipelineInput.

Definition at line 139 of file io.hpp.

InputStarIds()

const StarIdentifiers * lost::GeneratedPipelineInput::InputStarIds ( ) const

inlineoverridevirtual

The centroid indices in the StarIdentifiers returned from InputStarIds should be indices into InputStars(), not ExpectedStars(), when present, because otherwise it's useless.

Reimplemented from lost::PipelineInput.

Definition at line 143 of file io.hpp.

InputStars()

const Stars * lost::GeneratedPipelineInput::InputStars ( ) const

inlineoverridevirtual

Reimplemented from lost::PipelineInput.

Definition at line 140 of file io.hpp.

---

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

• src/io.hpp
• src/io.cpp