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

Detailed Description

Area Detection methods.

Inherits Rx::LFR::CParametersPimpl< CAreaDetection_Impl, Params::EAreaDetection::ID, Interfaces::EAreaDetection::ID >.

Public Types

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

Public Member Functions

 CAreaDetection ()
 Default constructor. More...
 
 ~CAreaDetection ()
 Destructor. More...
 
void Detect (const Rx::CRxArrayDouble adTemplate, const Rx::CRxArrayDouble adRoi, Rx::CRxArray< AreaDetection::SArea > *adDetectedAreas)
 Tries to find occurrences of the template described by the detection area in the given image. More...
 
void Free ()
 Frees the memory occupied by this object. More...
 
CAreaDetection_Impl & GetImpl ()
 Gets the non constant implementation. More...
 
const CAreaDetection_Impl & GetImpl () const
 Gets the constant implementation. More...
 
void * GetInterface (Interfaces::EAreaDetection::ID eInterface)
 Gets the interface defined by the given interface ID. More...
 
TInterface * GetInterface (Interfaces::EAreaDetection::ID eInterface)
 Gets the interface defined by the given interface ID. More...
 
const void * GetInterface (Interfaces::EAreaDetection::ID eInterface) const
 Gets the interface defined by the given interface ID. More...
 
const TInterface * GetInterface (Interfaces::EAreaDetection::ID eInterface) const
 Gets the interface defined by the given interface ID. More...
 
CParameters< Params::EAreaDetection::ID > & GetParams ()
 
const CParameters< Params::EAreaDetection::ID > & GetParams () const
 
bool HasInterface (Interfaces::EAreaDetection::ID eInterface)
 Queries if this object has the given interface. More...
 
void Initialize (const CCudaDevice &xCudaDevice)
 Initializes this object using the given CUDA device. More...
 
void SetImage (const CRayImage &xRayImage, const CRxString &sxComputeParams)
 Sets the image on which the detection shall take place. More...
 

Member Typedef Documentation

◆ EnumInterfaceType

◆ EnumType

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

Constructor & Destructor Documentation

◆ CAreaDetection()

Rx::LFR::CAreaDetection::CAreaDetection ( )

Default constructor.

◆ ~CAreaDetection()

Rx::LFR::CAreaDetection::~CAreaDetection ( )

Destructor.

Member Function Documentation

◆ Detect()

void Rx::LFR::CAreaDetection::Detect ( const Rx::CRxArrayDouble  adTemplate,
const Rx::CRxArrayDouble  adRoi,
Rx::CRxArray< AreaDetection::SArea > *  adDetectedAreas 
)

Tries to find occurrences of the template described by the detection area in the given image.

Parameters
adTemplateThe rectangle (4 values, top left x and y, width and height) describing the position of the template to look for in the rest of the image.
adRoiThe region of interest in which to look for the template (4 values, top left x and y, width and height). If width and height equal 0, no region of interest will be used.
adDetectedAreas[out] The detected areas.

◆ Free()

void Rx::LFR::CAreaDetection::Free ( )

Frees the memory occupied by this object.

◆ GetImpl() [1/2]

CAreaDetection_Impl & Rx::LFR::CPimpl< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetImpl
inlineinherited

Gets the non constant implementation.

Returns
The implementation.

◆ GetImpl() [2/2]

const CAreaDetection_Impl & Rx::LFR::CPimpl< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetImpl
inlineinherited

Gets the constant implementation.

Returns
The implementation.

◆ GetInterface() [1/4]

void* Rx::LFR::CPimpl< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetInterface ( Interfaces::EAreaDetection::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< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetInterface ( Interfaces::EAreaDetection::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< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetInterface ( Interfaces::EAreaDetection::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< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::GetInterface ( Interfaces::EAreaDetection::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< CAreaDetection_Impl , Interfaces::EAreaDetection::ID >::HasInterface ( Interfaces::EAreaDetection::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::CAreaDetection::Initialize ( const CCudaDevice xCudaDevice)

Initializes this object using the given CUDA device.

Parameters
xCudaDeviceThe CUDA device.

◆ SetImage()

void Rx::LFR::CAreaDetection::SetImage ( const CRayImage xRayImage,
const CRxString sxComputeParams 
)

Sets the image on which the detection shall take place.

Parameters
xRayImageThe image.
sxComputeParamsThe compute parameter used for computing the needed images.