Volume Cartographer 2.27.0
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
volcart::texturing::CompositeTexture Class Reference

Generate a texture image using a variety of composite volume filters. More...

#include <vc/texturing/CompositeTexture.hpp>

Inheritance diagram for volcart::texturing::CompositeTexture:
[legend]
Collaboration diagram for volcart::texturing::CompositeTexture:
[legend]

Public Types

enum class  Filter {
  Minimum = 0 , Maximum , Median , Mean ,
  MedianAverage
}
 
using Pointer = std::shared_ptr< CompositeTexture >
 
- Public Types inherited from volcart::texturing::TexturingAlgorithm
using Pointer = std::shared_ptr< TexturingAlgorithm >
 
using Texture = std::vector< cv::Mat >
 

Public Member Functions

 CompositeTexture ()=default
 
 ~CompositeTexture () override=default
 
 CompositeTexture (CompositeTexture &)=default
 
 CompositeTexture (CompositeTexture &&)=default
 
auto operator= (const CompositeTexture &) -> CompositeTexture &=default
 
auto operator= (CompositeTexture &&) -> CompositeTexture &=default
 
void setGenerator (NeighborhoodGenerator::Pointer g)
 Set the Neighborhood generator. More...
 
void setFilter (Filter f)
 Set the filtering method. More...
 
auto compute () -> Texture override
 Compute the Texture. More...
 
- Public Member Functions inherited from volcart::texturing::TexturingAlgorithm
virtual ~TexturingAlgorithm ()=default
 
void setPerPixelMap (PerPixelMap::Pointer ppm)
 Set the input PerPixelMap.
 
void setVolume (Volume::Pointer vol)
 Set the input Volume.
 
virtual auto compute () -> Texture=0
 Compute the Texture. More...
 
auto getTexture () -> Texture
 Get the generated Texture.
 
auto progressIterations () const -> std::size_t override
 Returns the maximum progress value. More...
 
virtual std::size_t progressIterations () const =0
 

Static Public Member Functions

static auto New () -> Pointer
 

Private Attributes

NeighborhoodGenerator::Pointer gen_
 
Filter filter_ {Filter::Maximum}
 

Additional Inherited Members

- Public Attributes inherited from volcart::IterationsProgress
Signal progressStarted
 
Signal< std::size_t > progressUpdated
 
Signal progressComplete
 
- Protected Member Functions inherited from volcart::texturing::TexturingAlgorithm
 TexturingAlgorithm ()=default
 
 TexturingAlgorithm (TexturingAlgorithm &)=default
 
 TexturingAlgorithm (TexturingAlgorithm &&)=default
 
auto operator= (const TexturingAlgorithm &) -> TexturingAlgorithm &=default
 
auto operator= (TexturingAlgorithm &&) -> TexturingAlgorithm &=default
 
- Protected Attributes inherited from volcart::texturing::TexturingAlgorithm
PerPixelMap::Pointer ppm_
 
Volume::Pointer vol_
 
Texture result_
 

Detailed Description

Generate a texture image using a variety of composite volume filters.

This class generates a texture image by filtering the Volume using one of a number of composite measures:

Definition at line 24 of file CompositeTexture.hpp.

Member Typedef Documentation

◆ Pointer

Pointer type

Definition at line 28 of file CompositeTexture.hpp.

Member Enumeration Documentation

◆ Filter

Filter list

Enumerator
Minimum 

Select the minimum intensity value.

Maximum 

Select the maximum intensity value.

Median 

Select the median intensity value.

Mean 

Calculate the mean intensity value.

MedianAverage 

Calculate the mean of the median 70% of values.

Definition at line 47 of file CompositeTexture.hpp.

Constructor & Destructor Documentation

◆ CompositeTexture() [1/3]

volcart::texturing::CompositeTexture::CompositeTexture ( )
default

Default constructor

◆ ~CompositeTexture()

volcart::texturing::CompositeTexture::~CompositeTexture ( )
overridedefault

Default destructor

◆ CompositeTexture() [2/3]

volcart::texturing::CompositeTexture::CompositeTexture ( CompositeTexture )
default

Default copy constructor

◆ CompositeTexture() [3/3]

volcart::texturing::CompositeTexture::CompositeTexture ( CompositeTexture &&  )
default

Default move constructor

Member Function Documentation

◆ compute()

auto volcart::texturing::CompositeTexture::compute ( ) -> Texture
overridevirtual

Compute the Texture.

Implements volcart::texturing::TexturingAlgorithm.

◆ New()

static auto volcart::texturing::CompositeTexture::New ( ) -> Pointer
static

Make shared pointer

◆ operator=() [1/2]

auto volcart::texturing::CompositeTexture::operator= ( CompositeTexture &&  ) -> CompositeTexture &=default
default

Default move operator

◆ operator=() [2/2]

auto volcart::texturing::CompositeTexture::operator= ( const CompositeTexture ) -> CompositeTexture &=default
default

Default copy operator

◆ setFilter()

void volcart::texturing::CompositeTexture::setFilter ( Filter  f)

Set the filtering method.

Default: Maximum

◆ setGenerator()

void volcart::texturing::CompositeTexture::setGenerator ( NeighborhoodGenerator::Pointer  g)

Set the Neighborhood generator.

This class supports generators of dimension >= 1

Member Data Documentation

◆ filter_

Filter volcart::texturing::CompositeTexture::filter_ {Filter::Maximum}
private

Filter method

Definition at line 86 of file CompositeTexture.hpp.

◆ gen_

NeighborhoodGenerator::Pointer volcart::texturing::CompositeTexture::gen_
private

Neighborhood shape

Definition at line 83 of file CompositeTexture.hpp.


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