Commit 2e67f2db authored by Will Schroeder's avatar Will Schroeder
Browse files

ENH: Added documentation.

parent 88a701ac
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -15,9 +13,15 @@ without the express written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Extracts geometry from arbitrary input
//
// .NAME vlGeometryFilter - extract geometry from data
// .SECTION Description
// vlGeometryFilter is a filter to extract geometry (and associated data)
// from a dataset. Geometry is obtained as follows: all 0D, 1D, and 2D cells
// are extracted. All 2D faces that are used by only one 3D cell (i.e.,
// boundary faces) are extracted. It is also possible to specify conditions
// on point ids, cell ids, and on bounding box to control the extraction
// process.
#ifndef __vlGeometryFilter_h
#define __vlGeometryFilter_h
......@@ -31,15 +35,41 @@ public:
char *GetClassName() {return "vlGeometryFilter";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Turn on/off selection of geometry by point id.
vlSetMacro(PointClipping,int);
vlGetMacro(PointClipping,int);
vlBooleanMacro(PointClipping,int);
// Description:
// Turn on/off selection of geometry by cell id.
vlSetMacro(CellClipping,int);
vlGetMacro(CellClipping,int);
vlBooleanMacro(CellClipping,int);
// Description:
// Turn on/off selection of geometry via bounding box.
vlSetMacro(ExtentClipping,int);
vlGetMacro(ExtentClipping,int);
vlBooleanMacro(ExtentClipping,int);
// Description:
// Specify the minimum point id for point id selection.
vlSetClampMacro(PointMinimum,int,0,LARGE_INTEGER);
vlGetMacro(PointMinimum,int);
// Description:
// Specify the maximum point id for point id selection.
vlSetClampMacro(PointMaximum,int,0,LARGE_INTEGER);
vlGetMacro(PointMaximum,int);
// Description:
// Specify the minimum cell id for point id selection.
vlSetClampMacro(CellMinimum,int,0,LARGE_INTEGER);
vlGetMacro(CellMinimum,int);
// Description:
// Specify the maximum cell id for point id selection.
vlSetClampMacro(CellMaximum,int,0,LARGE_INTEGER);
vlGetMacro(CellMaximum,int);
......@@ -47,18 +77,6 @@ public:
void SetExtent(float *extent);
float *GetExtent() { return this->Extent;};
vlSetMacro(PointClipping,int);
vlGetMacro(PointClipping,int);
vlBooleanMacro(PointClipping,int);
vlSetMacro(CellClipping,int);
vlGetMacro(CellClipping,int);
vlBooleanMacro(CellClipping,int);
vlSetMacro(ExtentClipping,int);
vlGetMacro(ExtentClipping,int);
vlBooleanMacro(ExtentClipping,int);
protected:
void Execute();
int PointMinimum;
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -16,8 +14,12 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// DataSetToPolyFilter are filters that take DataSets in and generate PolyData
//
// .NAME vlStructuredDataSetToPolyFilter - abstract filter class
// .SECTION Description
// vlStructuredDataSetToPolyFilter are filters whose subclasses take as input
// structured data (e.g., structured points, structured grid) and generate
// polygonal data on output.
#ifndef __vlStructuredDataSetToPolyFilter_h
#define __vlStructuredDataSetToPolyFilter_h
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -15,9 +13,14 @@ without the express written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Create geometry for structured data
//
// .NAME vlStructuredGeometryFilter - extract geometry for structured data
// .SECTION Description
// vlStructuredGeometryFilter is a filter that extracts geometry from
// structured data. By specifying appropriate i-j-k indices, it is possible
// to extract a point, a curve, a surface, or a "volume". Depending upon the
// type of data, the curve and surface may be curved or planar. The volume
// is actually a (n x m x o) region of points.
#ifndef __vlStructuredGeometryFilter_h
#define __vlStructuredGeometryFilter_h
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -36,13 +34,19 @@ public:
char *GetClassName() {return "vlStripper";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Specify the maximum number of triangles in a triangle strip.
vlSetClampMacro(MaximumStripLength,int,4,MAX_CELL_SIZE);
vlGetMacro(MaximumStripLength,int);
// Description:
// Turn on/off passing of vertices through to output.
vlBooleanMacro(PassVerts,int);
vlSetMacro(PassVerts,int);
vlGetMacro(PassVerts,int);
// Description:
// Turn on/off passing of lines through to output.
vlBooleanMacro(PassLines,int);
vlSetMacro(PassLines,int);
vlGetMacro(PassLines,int);
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -15,10 +13,14 @@ without the express written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Extracts cells where scalar value of every point in cell satisfies
// threshold criterion.
//
// .NAME vlThreshold - extracts cells where scalar value of every point in cell satisfies threshold criterion
// .SECTION Description
// vlThreshold is a filter that extracts cells from a dataset that satisfy a
// threshold criterion. A cell satisfies the criterion if the scalar value
// of every point satisfies the criterion. The criterion can take three forms:
// greater than a particular value, less than a particular value, between a
// particular value.
#ifndef __vlThreshold_h
#define __vlThreshold_h
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -17,6 +15,8 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
#include "GeomF.hh"
// Description:
// Construct with all types of clipping turned off.
vlGeometryFilter::vlGeometryFilter()
{
this->PointMinimum = 0;
......@@ -52,6 +52,8 @@ void vlGeometryFilter::SetExtent(float xMin, float xMax, float yMin,
this->SetExtent(extent);
}
// Description:
// Specify a (xmin,xmax, ymin,ymax, zmin,zmax) bounding box to clip data.
void vlGeometryFilter::SetExtent(float *extent)
{
int i;
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -17,6 +15,8 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
#include "StrGeomF.hh"
// Description:
// Construct with initial extent (0,100, 0,100, 0,0) (i.e., a plane).
vlStructuredGeometryFilter::vlStructuredGeometryFilter()
{
this->Extent[0] = 0;
......@@ -43,9 +43,6 @@ void vlStructuredGeometryFilter::Execute()
float *x;
vlDebugMacro(<< "Creating structured geometry");
//
// Initialize
//
this->Initialize();
pd = this->Input->GetPointData();
......@@ -262,6 +259,8 @@ void vlStructuredGeometryFilter::SetExtent(int iMin, int iMax, int jMin, int jMa
this->SetExtent(extent);
}
// Description:
// Specify (imin,imax, jmin,jmax, kmin,kmax) indices.
void vlStructuredGeometryFilter::SetExtent(int *extent)
{
int i;
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......
......@@ -6,8 +6,6 @@
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -17,15 +15,18 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
#include "Threshld.hh"
// Construct with lower threshold=0, upper threshold=1, and threshold
// function=upper.
vlThreshold::vlThreshold()
{
this->LowerThreshold = 0.0;
this->UpperThreshold = 1.0;
// this->ThresholdFunction = this->Upper;
this->ThresholdFunction = this->Upper;
}
// Description:
// Criterion is cells whose scalars are less than lower threshold.
void vlThreshold::ThresholdByLower(float lower)
{
if ( this->LowerThreshold != lower )
......@@ -36,6 +37,8 @@ void vlThreshold::ThresholdByLower(float lower)
}
}
// Description:
// Criterion is cells whose scalars are less than upper threshold.
void vlThreshold::ThresholdByUpper(float upper)
{
if ( this->UpperThreshold != upper )
......@@ -46,6 +49,8 @@ void vlThreshold::ThresholdByUpper(float upper)
}
}
// Description:
// Criterion is cells whose scalars are between lower and upper thresholds.
void vlThreshold::ThresholdBetween(float lower, float upper)
{
if ( this->LowerThreshold != lower || this->UpperThreshold != upper )
......@@ -71,8 +76,6 @@ void vlThreshold::Execute()
float *x;
vlDebugMacro(<< "Executing threshold filter");
// check input
this->Initialize();
if ( ! (inScalars = this->Input->GetPointData()->GetScalars()) )
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment