mitk::PlanarFigureSource Class Reference [Process Classes]

Base class for all filters which have an object of type mitk::PlanarFigure as output. More...

#include <mitkPlanarFigureSource.h>

Inheritance diagram for mitk::PlanarFigureSource:

Collaboration diagram for mitk::PlanarFigureSource:

List of all members.

Public Types
typedef PlanarFigureSource	Self
typedef BaseProcess	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef mitk::PlanarFigure	OutputType
typedef OutputType::Pointer	OutputTypePointer
typedef itk::DataObject::Pointer	DataObjectPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual DataObjectPointer	MakeOutput (unsigned int idx)
void	GenerateInputRequestedRegion ()
void	SetOutput (OutputType *output)
virtual void	GraftOutput (itk::DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
OutputType *	GetOutput ()
OutputType *	GetOutput (unsigned int idx)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	PlanarFigureSource ()
virtual	~PlanarFigureSource ()

---

Detailed Description

Base class for all filters which have an object of type mitk::PlanarFigure as output.

Base class for all filters which have an object of type mitk::PlanarFigure as output. mitk::PlanarFigureSources do not provide support for streaming, that is, that the requested region is always the largest possible region.

Definition at line 39 of file mitkPlanarFigureSource.h.

---

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::PlanarFigureSource::ConstPointer

Reimplemented in mitk::PlanarFigureReader.

Definition at line 42 of file mitkPlanarFigureSource.h.

typedef itk::DataObject::Pointer mitk::PlanarFigureSource::DataObjectPointer

Definition at line 47 of file mitkPlanarFigureSource.h.

typedef mitk::PlanarFigure mitk::PlanarFigureSource::OutputType

Definition at line 43 of file mitkPlanarFigureSource.h.

typedef OutputType::Pointer mitk::PlanarFigureSource::OutputTypePointer

Definition at line 46 of file mitkPlanarFigureSource.h.

typedef itk::SmartPointer<Self> mitk::PlanarFigureSource::Pointer

Reimplemented in mitk::PlanarFigureReader.

Definition at line 42 of file mitkPlanarFigureSource.h.

typedef PlanarFigureSource mitk::PlanarFigureSource::Self

Reimplemented in mitk::PlanarFigureReader.

Definition at line 42 of file mitkPlanarFigureSource.h.

typedef BaseProcess mitk::PlanarFigureSource::Superclass

Reimplemented in mitk::PlanarFigureReader.

Definition at line 42 of file mitkPlanarFigureSource.h.

---

Constructor & Destructor Documentation

mitk::PlanarFigureSource::PlanarFigureSource

(

)

[protected]

Definition at line 21 of file mitkPlanarFigureSource.cpp.

{
    // Create the output. We use static_cast<> here because we know the default
    // output must be of type TOutputImage
    //OutputType::Pointer output = static_cast<OutputType*>( this->MakeOutput( 0 ).GetPointer() );

    //if ( output.GetPointer() == NULL )
    //{
    //    itkWarningMacro(<<"Output could not be created!");
    //}
    //this->ProcessObject::SetNumberOfRequiredOutputs( 1 );
    //this->ProcessObject::SetNthOutput( 0, output.GetPointer() );
}

mitk::PlanarFigureSource::~PlanarFigureSource

(

)

[protected, virtual]

Definition at line 36 of file mitkPlanarFigureSource.cpp.

{}

---

Member Function Documentation

void mitk::PlanarFigureSource::GenerateInputRequestedRegion

(

)

Generates the input requested region simply by calling the equivalent method of the superclass.

Definition at line 71 of file mitkPlanarFigureSource.cpp.

{
    this->ProcessObject::GenerateInputRequestedRegion();
}

virtual const char* mitk::PlanarFigureSource::GetClassName

(

)

const [virtual]

Reimplemented in mitk::PlanarFigureReader.

mitk::PlanarFigureSource::OutputType * mitk::PlanarFigureSource::GetOutput

(

unsigned int

idx )

Returns the nth output of the planar figure source

Parameters:

idx	the index of the wanted output

Returns:

the output with index idx.

Definition at line 66 of file mitkPlanarFigureSource.cpp.

{
    return static_cast<OutputType*> ( this->ProcessObject::GetOutput( idx ) );
}

mitk::PlanarFigureSource::OutputType * mitk::PlanarFigureSource::GetOutput

(

void

)

Returns the output with index 0 of the planar figure source

Returns:

the output

Definition at line 53 of file mitkPlanarFigureSource.cpp.

{
    if ( this->GetNumberOfOutputs() < 1 )
    {
        return 0;
    }

    if ( static_cast<OutputType*> ( this->ProcessObject::GetOutput( 0 ) ) == NULL )
        itkWarningMacro(<<"Output is NULL!");
    return static_cast<OutputType*> ( this->ProcessObject::GetOutput( 0 ) );
}

void mitk::PlanarFigureSource::GraftNthOutput	(	unsigned int	idx,
		itk::DataObject *	graft
	)		[virtual]

Graft output idx to the parameter graft

Definition at line 83 of file mitkPlanarFigureSource.cpp.

{
  if ( idx >= this->GetNumberOfOutputs() )
  {
    itkExceptionMacro(<<"Requested to graft output " << idx << 
      " but this filter only has " << this->GetNumberOfOutputs() << " Outputs.");
  }  

  if ( !graft )
  {
    itkExceptionMacro(<<"Requested to graft output with a NULL pointer object" );
  }

  itk::DataObject* output = this->GetOutput(idx);
  if ( !output )
  {
    itkExceptionMacro(<<"Requested to graft output that is a NULL pointer" );
  }
  // Call Graft on NavigationData to copy member data
  output->Graft( graft );
}

void mitk::PlanarFigureSource::GraftOutput

(

itk::DataObject *

graft )

[virtual]

Graft output 0 to the parameter graft

Definition at line 77 of file mitkPlanarFigureSource.cpp.

{
  this->GraftNthOutput(0, graft);
}

mitk::PlanarFigureSource::DataObjectPointer mitk::PlanarFigureSource::MakeOutput

(

unsigned int

idx )

[virtual]

Allocates a new output object and returns it.

Parameters:

idx	the index of the output for which an object should be created

Returns:

the new object

Reimplemented in mitk::PlanarFigureReader.

Definition at line 40 of file mitkPlanarFigureSource.cpp.

{
  return NULL;
}

static Pointer mitk::PlanarFigureSource::New

(

)

[static]

Reimplemented in mitk::PlanarFigureReader.

void mitk::PlanarFigureSource::SetOutput

(

OutputType *

output )

Allows to set the output of the planar figure source. According to the itk documentation this method is outdated and should not be used. Instead GraftOutput(...) should be used.

Parameters:

output

the intended output of the planar figure source

Definition at line 46 of file mitkPlanarFigureSource.cpp.

{
    itkWarningMacro( << "SetOutput(): This method is slated to be removed from ITK.  Please use GraftOutput() in possible combination with DisconnectPipeline() instead." );
    this->SetNthOutput( 0, output );
}

---

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

• mitkPlanarFigureSource.h
• mitkPlanarFigureSource.cpp