CVBpy 14.1
CubeRange Class Reference

3D rectangle in the samples, lines and bands domain. More...

Inherits object.

Public Member Functions

bool contains (self, cvb.Point3D point)
 Checks if the point is inside the cube range. More...
 
bool intersects_with (self, cvb.spectral.CubeRange other)
 Checks if this cuboid intersects with another cube range. More...
 

Properties

 bands = property
 cvb.NumberRange: Gets or sets the range in the bands dimensions.
 
 lines = property
 cvb.NumberRange: Gets or sets the range in the lines dimensions.
 
 samples = property
 cvb.NumberRange: Gets or sets the range in the samples dimensions.
 

Detailed Description

3D rectangle in the samples, lines and bands domain.

Creates cube range.

Region resembling a 3D value range for hyper spectral cubes. There are two possibilities to create a CubeRange object:

Parameters

lines : cvb.NumberRange Range regarding the lines dimension.

samples : cvb.NumberRange Range regarding the samples dimension.

bands : cvb.NumberRange Range regarding the bands dimension.

Parameters

lines_list : List[float] Range regarding the lines dimension [start, end].

samples_list : List[float] Range regarding the samples dimension [start, end].

bands_list : List[float] Range regarding the bands dimension [start, end].

Member Function Documentation

◆ contains()

bool contains (   self,
cvb.Point3D  point 
)

Checks if the point is inside the cube range.

Parameters

point : cvb.Point3D Point to be checked.

Returns

bool True if the point is within the cube range, False otherwise.

◆ intersects_with()

bool intersects_with (   self,
cvb.spectral.CubeRange  other 
)

Checks if this cuboid intersects with another cube range.

Parameters

other : cvb.spectral.CubeRange Other cube range for intersection test.

Returns

bool True if this cube range and the other cube range have at least one value in common, False otherwise.