Raytrix Light Field SDK  5.0
Rx::LFR::CHighResolutionParticleDetector Class Reference

Detailed Description

Provides methods to perform high resolution particle detection.

Inherits Rx::LFR::CParametersPimpl< CHighResolutionParticleDetector_Impl, Params::EHighResolutionParticleDetector::ID, Interfaces::EHighResolutionParticleDetector::ID >.

Public Types

typedef Interfaces::EHighResolutionParticleDetector::ID EnumInterfaceType
 
typedef Params::EHighResolutionParticleDetector::ID EnumType
 The type of the parameter enum. Is used by managed wrapper classes. More...
 

Public Member Functions

 CHighResolutionParticleDetector ()
 Default constructor. More...
 
 CHighResolutionParticleDetector (CHighResolutionParticleDetector &&xHighResolutionParticleDetector)
 Move constructor. More...
 
 ~CHighResolutionParticleDetector ()
 Destructor. More...
 
void AddImageToBackground (const Rx::LFR::CRayImage &xImage)
 Adds an image to background. More...
 
void ComputeBackground ()
 Calculates the background. More...
 
void CreateHighResolutionTracks ()
 Filter tracks. More...
 
void DetectParticles (const Rx::CRxString &sSequenceFilename)
 Detect particles. More...
 
void DetectParticles (const Rx::LFR::CRayImage &xImage)
 Detect particles. More...
 
void GetFoundEllipses2D (Rx::CRxArray< ParticleDetection::SEllipses2D > &axEllipses)
 Gets found ellipses. More...
 
void GetFoundEllipses3D (Rx::CRxArray< ParticleDetection::SEllipses3D > &axEllipses)
 Gets found ellipses. More...
 
void GetFoundHighResolutionParticles (Rx::CRxArray< ParticleDetection::SHighResolutionParticle > &axHighResolutionParticles)
 Gets found high resolution particle. More...
 
void GetFoundTracks (Rx::CRxArray< ParticleDetection::STrack > &axTracks)
 Gets found tracks. More...
 
void GetHighResolutionParticleTracks (Rx::CRxArray< ParticleDetection::STrack > &axTracks)
 Gets high resolution particle tracks. More...
 
void GetImage (CRxImage &xImage, int iImage)
 Gets an image. More...
 
CHighResolutionParticleDetector_Impl & GetImpl ()
 Gets the non constant implementation. More...
 
const CHighResolutionParticleDetector_Impl & GetImpl () const
 Gets the constant implementation. More...
 
void * GetInterface (Interfaces::EHighResolutionParticleDetector::ID eInterface)
 Gets the interface defined by the given interface ID. More...
 
TInterface * GetInterface (Interfaces::EHighResolutionParticleDetector::ID eInterface)
 Gets the interface defined by the given interface ID. More...
 
const void * GetInterface (Interfaces::EHighResolutionParticleDetector::ID eInterface) const
 Gets the interface defined by the given interface ID. More...
 
const TInterface * GetInterface (Interfaces::EHighResolutionParticleDetector::ID eInterface) const
 Gets the interface defined by the given interface ID. More...
 
CParameters< Params::EHighResolutionParticleDetector::ID > & GetParams ()
 
const CParameters< Params::EHighResolutionParticleDetector::ID > & GetParams () const
 
bool HasInterface (Interfaces::EHighResolutionParticleDetector::ID eInterface)
 Queries if this object has the given interface. More...
 
void Initialize (const CCalibration &xCalib)
 Initializes this object. More...
 
CHighResolutionParticleDetectoroperator= (CHighResolutionParticleDetector &&xHighResolutionParticleDetector)
 Move assignment operator. More...
 
void SetCudaDevice (const CCudaDevice &xCudaDevice)
 Sets the CUDA device for the high resolution particle detector. More...
 

Member Typedef Documentation

◆ EnumInterfaceType

◆ EnumType

The type of the parameter enum. Is used by managed wrapper classes.

Constructor & Destructor Documentation

◆ CHighResolutionParticleDetector() [1/2]

Rx::LFR::CHighResolutionParticleDetector::CHighResolutionParticleDetector ( )

Default constructor.

◆ CHighResolutionParticleDetector() [2/2]

Rx::LFR::CHighResolutionParticleDetector::CHighResolutionParticleDetector ( CHighResolutionParticleDetector &&  xHighResolutionParticleDetector)

Move constructor.

Parameters
xHighResolutionParticleDetector[in,out] The high resolution particle detection instance.

◆ ~CHighResolutionParticleDetector()

Rx::LFR::CHighResolutionParticleDetector::~CHighResolutionParticleDetector ( )

Destructor.

Member Function Documentation

◆ AddImageToBackground()

void Rx::LFR::CHighResolutionParticleDetector::AddImageToBackground ( const Rx::LFR::CRayImage xImage)

Adds an image to background.

Parameters
xImage[in] The image.

◆ ComputeBackground()

void Rx::LFR::CHighResolutionParticleDetector::ComputeBackground ( )

Calculates the background.

◆ CreateHighResolutionTracks()

void Rx::LFR::CHighResolutionParticleDetector::CreateHighResolutionTracks ( )

Filter tracks.

◆ DetectParticles() [1/2]

void Rx::LFR::CHighResolutionParticleDetector::DetectParticles ( const Rx::CRxString sSequenceFilename)

Detect particles.

Parameters
sSequenceFilename[in] Filename of the sequence file.

◆ DetectParticles() [2/2]

void Rx::LFR::CHighResolutionParticleDetector::DetectParticles ( const Rx::LFR::CRayImage xImage)

Detect particles.

Parameters
xImage[in] The image.

◆ GetFoundEllipses2D()

void Rx::LFR::CHighResolutionParticleDetector::GetFoundEllipses2D ( Rx::CRxArray< ParticleDetection::SEllipses2D > &  axEllipses)

Gets found ellipses.

Parameters
axEllipses[out] The ellipses array.

◆ GetFoundEllipses3D()

void Rx::LFR::CHighResolutionParticleDetector::GetFoundEllipses3D ( Rx::CRxArray< ParticleDetection::SEllipses3D > &  axEllipses)

Gets found ellipses.

Parameters
axEllipses[out] The ellipses array.

◆ GetFoundHighResolutionParticles()

void Rx::LFR::CHighResolutionParticleDetector::GetFoundHighResolutionParticles ( Rx::CRxArray< ParticleDetection::SHighResolutionParticle > &  axHighResolutionParticles)

Gets found high resolution particle.

Parameters
axHighResolutionParticles[out] The high resolution particle array.

◆ GetFoundTracks()

void Rx::LFR::CHighResolutionParticleDetector::GetFoundTracks ( Rx::CRxArray< ParticleDetection::STrack > &  axTracks)

Gets found tracks.

Parameters
axTracks[in] The tracks.

◆ GetHighResolutionParticleTracks()

void Rx::LFR::CHighResolutionParticleDetector::GetHighResolutionParticleTracks ( Rx::CRxArray< ParticleDetection::STrack > &  axTracks)

Gets high resolution particle tracks.

Parameters
axTracks[out] The tracks.

◆ GetImage()

void Rx::LFR::CHighResolutionParticleDetector::GetImage ( CRxImage xImage,
int  iImage 
)

Gets an image.

0 = Foreground image. 1 = Blurred foreground image.

Parameters
xImage[out] The image.
iImage[in] Image Type

◆ GetImpl() [1/2]

CHighResolutionParticleDetector_Impl & Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetImpl
inlineinherited

Gets the non constant implementation.

Returns
The implementation.

◆ GetImpl() [2/2]

const CHighResolutionParticleDetector_Impl & Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetImpl
inlineinherited

Gets the constant implementation.

Returns
The implementation.

◆ GetInterface() [1/4]

void* Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetInterface ( Interfaces::EHighResolutionParticleDetector::ID  eInterface)
inherited

Gets the interface defined by the given interface ID.

Parameters
eInterface[in] The interface ID.
Returns
Null if it fails, else the interface.

◆ GetInterface() [2/4]

TInterface* Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetInterface ( Interfaces::EHighResolutionParticleDetector::ID  eInterface)
inlineinherited

Gets the interface defined by the given interface ID.

Template Parameters
TInterface[in] The interface type.
Parameters
eInterface[in] The interface.
Returns
Null if it fails, else the interface.

◆ GetInterface() [3/4]

const void* Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetInterface ( Interfaces::EHighResolutionParticleDetector::ID  eInterface) const
inherited

Gets the interface defined by the given interface ID.

Parameters
eInterface[in] The interface ID.
Returns
Null if it fails, else the interface.

◆ GetInterface() [4/4]

const TInterface* Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::GetInterface ( Interfaces::EHighResolutionParticleDetector::ID  eInterface) const
inlineinherited

Gets the interface defined by the given interface ID.

Template Parameters
TInterface[in] The interface type.
Parameters
eInterface[in] The interface ID.
Returns
Null if it fails, else the interface.

◆ GetParams() [1/2]

◆ GetParams() [2/2]

◆ HasInterface()

bool Rx::LFR::CPimpl< CHighResolutionParticleDetector_Impl , Interfaces::EHighResolutionParticleDetector::ID >::HasInterface ( Interfaces::EHighResolutionParticleDetector::ID  eInterface)
inlineinherited

Queries if this object has the given interface.

Parameters
eInterface[in] The interface to query.
Returns
True if this class has the given interface, false if not.

◆ Initialize()

void Rx::LFR::CHighResolutionParticleDetector::Initialize ( const CCalibration xCalib)

Initializes this object.

Parameters
xCalib[in] The calibration.

◆ operator=()

CHighResolutionParticleDetector& Rx::LFR::CHighResolutionParticleDetector::operator= ( CHighResolutionParticleDetector &&  xHighResolutionParticleDetector)

Move assignment operator.

Parameters
xHighResolutionParticleDetector[in,out] The high resolution particle detection instance.
Returns
The instance.

◆ SetCudaDevice()

void Rx::LFR::CHighResolutionParticleDetector::SetCudaDevice ( const CCudaDevice xCudaDevice)

Sets the CUDA device for the high resolution particle detector.

Parameters
xCudaDevice[in] The CUDA device.