Drake
Drake C++ Documentation
DepthRange Class Reference

Detailed Description

Defines a depth sensor's functional range.

Only points that lie within the range [min_depth, max_depth] will register meaningful values.

Note
It's important to carefully coordinate depth range and clipping planes. It might seem reasonable to use the depth range as clipping planes, but that would be a mistake. Objects closer than the depth range's minimum value have an occluding effect in reality. If the near clipping plane is set to the minimum depth range value, those objects will be clipped away and won't occlude as they should. In essence, the camera will see through them and return incorrect values from beyond the missing geometry. The near clipping plane should always be closer than the minimum depth range. How much closer depends on the scenario. Given the scenario, evaluate the closest possible distance to the camera that geometry in the scene could possibly achieve; the clipping plane should be slightly closer than that. When in doubt, some very small value (e.g., 1 mm) is typically safe.

#include <drake/geometry/render/render_camera.h>

Public Member Functions

 DepthRange (double min_in, double max_in)
 Constructs the DepthRange. More...
 
double min_depth () const
 
double max_depth () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 DepthRange (const DepthRange &)=default
 
DepthRangeoperator= (const DepthRange &)=default
 
 DepthRange (DepthRange &&)=default
 
DepthRangeoperator= (DepthRange &&)=default
 

Constructor & Destructor Documentation

◆ DepthRange() [1/3]

DepthRange ( const DepthRange )
default

◆ DepthRange() [2/3]

DepthRange ( DepthRange &&  )
default

◆ DepthRange() [3/3]

DepthRange ( double  min_in,
double  max_in 
)

Constructs the DepthRange.

Exceptions
std::exceptionif either value isn't finite and positive, or if min_in >= max_in.

Member Function Documentation

◆ max_depth()

double max_depth ( ) const

◆ min_depth()

double min_depth ( ) const

◆ operator=() [1/2]

DepthRange& operator= ( const DepthRange )
default

◆ operator=() [2/2]

DepthRange& operator= ( DepthRange &&  )
default

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