find halos within a cosmology data file More...

#include <vtkPLANLHaloFinder.h>

Inherits vtkUnstructuredGridAlgorithm.

Public Types
enum	{ AVERAGE = 0, CENTER_OF_MASS = 1, MBP = 2, MCP = 3, NUMBER_OF_CENTER_FINDING_METHODS }

typedef vtkUnstructuredGridAlgorithm	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)


virtual vtkMultiProcessController *	GetController ()
	Set the communicator object for interprocess communication. More...

virtual void	SetController (vtkMultiProcessController *)
	Set the communicator object for interprocess communication. More...


virtual void	SetNP (int)
	Specify the number of seeded particles in one dimension (total = np^3) (default 256) More...

virtual int	GetNP ()
	Specify the number of seeded particles in one dimension (total = np^3) (default 256) More...


virtual void	SetRL (float)
	Specify the physical box dimensions size (rL) (default 100.0) More...

virtual float	GetRL ()
	Specify the physical box dimensions size (rL) (default 100.0) More...


virtual void	SetOverlap (float)
	Specify the ghost cell spacing (in rL units) (edge boundary of processor box) (default 5) More...

virtual float	GetOverlap ()
	Specify the ghost cell spacing (in rL units) (edge boundary of processor box) (default 5) More...


virtual void	SetPMin (int)
	Specify the minimum number of particles for a halo (pmin) (default 100) More...

virtual int	GetPMin ()
	Specify the minimum number of particles for a halo (pmin) (default 100) More...


virtual void	SetBB (float)
	Specify the linking length (bb) (default .2) More...

virtual float	GetBB ()
	Specify the linking length (bb) (default .2) More...


virtual void	SetComputeSOD (int)
	Turn on calculation of SOD halos (default off) More...

virtual int	GetComputeSOD ()
	Turn on calculation of SOD halos (default off) More...


virtual void	SetCenterFindingMethod (int)
	Specify the FOF center to use in SOD calculations (0 = default, center of mass, 1 = average, 2 = MBP, 3 = MCP) More...

virtual int	GetCenterFindingMethod ()
	Specify the FOF center to use in SOD calculations (0 = default, center of mass, 1 = average, 2 = MBP, 3 = MCP) More...


virtual void	SetRhoC (float)
	Specify rho_c (critical density) (default 2.77536627e11) More...

virtual float	GetRhoC ()
	Specify rho_c (critical density) (default 2.77536627e11) More...


virtual void	SetSODMass (float)
	Specify the initial SOD mass (default 1.0e14) More...

virtual float	GetSODMass ()
	Specify the initial SOD mass (default 1.0e14) More...


virtual void	SetMinRadiusFactor (float)
	Specify the minimum radius factor (default 0.5) More...

virtual float	GetMinRadiusFactor ()
	Specify the minimum radius factor (default 0.5) More...


virtual void	SetMaxRadiusFactor (float)
	Specify the maximum radius factor (default 2.0) More...

virtual float	GetMaxRadiusFactor ()
	Specify the maximum radius factor (default 2.0) More...


virtual void	SetSODBins (int)
	Specify the number of bins for SOD finding (default 20) More...

virtual int	GetSODBins ()
	Specify the number of bins for SOD finding (default 20) More...


virtual void	SetMinFOFSize (int)
	Specify the minimum FOF size for an SOD halo (default 1000) More...

virtual int	GetMinFOFSize ()
	Specify the minimum FOF size for an SOD halo (default 1000) More...


virtual void	SetMinFOFMass (float)
	Specify the minimum FOF mass for an SOD halo (default 5.0e12) More...

virtual float	GetMinFOFMass ()
	Specify the minimum FOF mass for an SOD halo (default 5.0e12) More...

Static Public Member Functions
static vtkPLANLHaloFinder *	New ()

static int	IsTypeOf (const char *type)

static vtkPLANLHaloFinder *	SafeDownCast (vtkObject *o)

Public Attributes
enum vtkPLANLHaloFinder:: { ... }	CenterDetectionAlgorithm

Protected Member Functions
	vtkPLANLHaloFinder ()

	~vtkPLANLHaloFinder ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

bool	CheckOutputIntegrity (vtkUnstructuredGrid *outputParticles)
	Checks the integrid of the output particles. More...

void	ComputeFOFHalos (vtkUnstructuredGrid particles, vtkUnstructuredGrid haloCenters)
	Computes the FOF halos based on the user-supplied linking length and PMin parameters. More...

void	ComputeSODHalos (vtkUnstructuredGrid particles, vtkUnstructuredGrid haloCenters)
	Given pre-computed FOF halos, this method computes the SOD halos. More...

void	VectorizeData (vtkUnstructuredGrid *particles)
	Vectorize the data since the halo-finder expects the data as different vectors. More...

void	ComputeFOFHaloProperties ()
	Computes FOF halo properties, i.e., fofMass, fofXPos, etc. More...

void	InitializeHaloCenters (vtkUnstructuredGrid *haloCenters, unsigned int N)
	Initializes the haloCenter output (output-2 of the filter) s.t. More...

void	MarkHaloParticlesAndGetCenter (const unsigned int halo, const int internalHaloIdx, double center[3], vtkUnstructuredGrid *particles)
	Marks the halos of the given halo and computes the center using the prescribed center-finding method. More...

void	ResetHaloFinderInternals ()
	Resets halo-finder internal data-structures. More...

void	InitializeSODHaloArrays (vtkUnstructuredGrid *haloCenters)
	Initialize the SOD haloArrays. More...

Protected Attributes
vtkMultiProcessController *	Controller

int	NP

float	RL

float	Overlap

int	PMin

float	BB

int	CenterFindingMethod

int	ComputeSOD

float	RhoC

float	SODMass

float	MinRadiusFactor

float	MaxRadiusFactor

int	SODBins

int	MinFOFSize

float	MinFOFMass

HaloFinderInternals::ParticleData *	Particles

HaloFinderInternals::HaloData *	Halos

cosmotk::CosmoHaloFinderP *	HaloFinder

Detailed Description

find halos within a cosmology data file

vtkPLANLHaloFinder is a filter object that operates on the unstructured grid of all particles and assigns each particle a halo id.

Definition at line 96 of file vtkPLANLHaloFinder.h.

Member Typedef Documentation

§ Superclass

typedef vtkUnstructuredGridAlgorithm vtkPLANLHaloFinder::Superclass

Definition at line 110 of file vtkPLANLHaloFinder.h.

Member Enumeration Documentation

§ anonymous enum

anonymous enum

Enumerator
AVERAGE
CENTER_OF_MASS
MBP
MCP
NUMBER_OF_CENTER_FINDING_METHODS

Definition at line 99 of file vtkPLANLHaloFinder.h.

Constructor & Destructor Documentation

§ vtkPLANLHaloFinder()

vtkPLANLHaloFinder::vtkPLANLHaloFinder ( )

protected

§ ~vtkPLANLHaloFinder()

vtkPLANLHaloFinder::~vtkPLANLHaloFinder ( )

protected

Member Function Documentation

§ New()

static vtkPLANLHaloFinder* vtkPLANLHaloFinder::New ( )

static

§ GetClassName()

virtual const char* vtkPLANLHaloFinder::GetClassName ( )

virtual

§ IsTypeOf()

static int vtkPLANLHaloFinder::IsTypeOf ( const char * type )

static

§ IsA()

virtual int vtkPLANLHaloFinder::IsA ( const char * type )

virtual

§ SafeDownCast()

static vtkPLANLHaloFinder* vtkPLANLHaloFinder::SafeDownCast ( vtkObject * o )

static

§ PrintSelf()

void vtkPLANLHaloFinder::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

§ GetController()

virtual vtkMultiProcessController* vtkPLANLHaloFinder::GetController ( )

virtual

Set the communicator object for interprocess communication.

§ SetController()

virtual void vtkPLANLHaloFinder::SetController ( vtkMultiProcessController * )

virtual

Set the communicator object for interprocess communication.

§ SetNP()

virtual void vtkPLANLHaloFinder::SetNP ( int )

virtual

Specify the number of seeded particles in one dimension (total = np^3) (default 256)

§ GetNP()

virtual int vtkPLANLHaloFinder::GetNP ( )

virtual

Specify the number of seeded particles in one dimension (total = np^3) (default 256)

§ SetRL()

virtual void vtkPLANLHaloFinder::SetRL ( float )

virtual

Specify the physical box dimensions size (rL) (default 100.0)

§ GetRL()

virtual float vtkPLANLHaloFinder::GetRL ( )

virtual

Specify the physical box dimensions size (rL) (default 100.0)

§ SetOverlap()

virtual void vtkPLANLHaloFinder::SetOverlap ( float )

virtual

Specify the ghost cell spacing (in rL units) (edge boundary of processor box) (default 5)

§ GetOverlap()

virtual float vtkPLANLHaloFinder::GetOverlap ( )

virtual

Specify the ghost cell spacing (in rL units) (edge boundary of processor box) (default 5)

§ SetPMin()

virtual void vtkPLANLHaloFinder::SetPMin ( int )

virtual

Specify the minimum number of particles for a halo (pmin) (default 100)

§ GetPMin()

virtual int vtkPLANLHaloFinder::GetPMin ( )

virtual

Specify the minimum number of particles for a halo (pmin) (default 100)

§ SetBB()

virtual void vtkPLANLHaloFinder::SetBB ( float )

virtual

Specify the linking length (bb) (default .2)

§ GetBB()

virtual float vtkPLANLHaloFinder::GetBB ( )

virtual

Specify the linking length (bb) (default .2)

§ SetComputeSOD()

virtual void vtkPLANLHaloFinder::SetComputeSOD ( int )

virtual

Turn on calculation of SOD halos (default off)

§ GetComputeSOD()

virtual int vtkPLANLHaloFinder::GetComputeSOD ( )

virtual

Turn on calculation of SOD halos (default off)

§ SetCenterFindingMethod()

virtual void vtkPLANLHaloFinder::SetCenterFindingMethod ( int )

virtual

Specify the FOF center to use in SOD calculations (0 = default, center of mass, 1 = average, 2 = MBP, 3 = MCP)

§ GetCenterFindingMethod()

virtual int vtkPLANLHaloFinder::GetCenterFindingMethod ( )

virtual

Specify the FOF center to use in SOD calculations (0 = default, center of mass, 1 = average, 2 = MBP, 3 = MCP)

§ SetRhoC()

virtual void vtkPLANLHaloFinder::SetRhoC ( float )

virtual

Specify rho_c (critical density) (default 2.77536627e11)

§ GetRhoC()

virtual float vtkPLANLHaloFinder::GetRhoC ( )

virtual

Specify rho_c (critical density) (default 2.77536627e11)

§ SetSODMass()

virtual void vtkPLANLHaloFinder::SetSODMass ( float )

virtual

Specify the initial SOD mass (default 1.0e14)

§ GetSODMass()

virtual float vtkPLANLHaloFinder::GetSODMass ( )

virtual

Specify the initial SOD mass (default 1.0e14)

§ SetMinRadiusFactor()

virtual void vtkPLANLHaloFinder::SetMinRadiusFactor ( float )

virtual

Specify the minimum radius factor (default 0.5)

§ GetMinRadiusFactor()

virtual float vtkPLANLHaloFinder::GetMinRadiusFactor ( )

virtual

Specify the minimum radius factor (default 0.5)

§ SetMaxRadiusFactor()

virtual void vtkPLANLHaloFinder::SetMaxRadiusFactor ( float )

virtual

Specify the maximum radius factor (default 2.0)

§ GetMaxRadiusFactor()

virtual float vtkPLANLHaloFinder::GetMaxRadiusFactor ( )

virtual

Specify the maximum radius factor (default 2.0)

§ SetSODBins()

virtual void vtkPLANLHaloFinder::SetSODBins ( int )

virtual

Specify the number of bins for SOD finding (default 20)

§ GetSODBins()

virtual int vtkPLANLHaloFinder::GetSODBins ( )

virtual

Specify the number of bins for SOD finding (default 20)

§ SetMinFOFSize()

virtual void vtkPLANLHaloFinder::SetMinFOFSize ( int )

virtual

Specify the minimum FOF size for an SOD halo (default 1000)

§ GetMinFOFSize()

virtual int vtkPLANLHaloFinder::GetMinFOFSize ( )

virtual

Specify the minimum FOF size for an SOD halo (default 1000)

§ SetMinFOFMass()

virtual void vtkPLANLHaloFinder::SetMinFOFMass ( float )

virtual

Specify the minimum FOF mass for an SOD halo (default 5.0e12)

§ GetMinFOFMass()

virtual float vtkPLANLHaloFinder::GetMinFOFMass ( )

virtual

Specify the minimum FOF mass for an SOD halo (default 5.0e12)

§ RequestData()

virtual int vtkPLANLHaloFinder::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

§ CheckOutputIntegrity()

bool vtkPLANLHaloFinder::CheckOutputIntegrity ( vtkUnstructuredGrid * outputParticles )

protected

Checks the integrid of the output particles.

Primarily the method ensures that required arrays used in computation are available.

§ ComputeFOFHalos()

void vtkPLANLHaloFinder::ComputeFOFHalos	(	vtkUnstructuredGrid *	particles,
		vtkUnstructuredGrid *	haloCenters
	)

protected

Computes the FOF halos based on the user-supplied linking length and PMin parameters.

§ ComputeSODHalos()

void vtkPLANLHaloFinder::ComputeSODHalos	(	vtkUnstructuredGrid *	particles,
		vtkUnstructuredGrid *	haloCenters
	)

protected

Given pre-computed FOF halos, this method computes the SOD halos.

§ VectorizeData()

void vtkPLANLHaloFinder::VectorizeData ( vtkUnstructuredGrid * particles )

protected

Vectorize the data since the halo-finder expects the data as different vectors.

§ ComputeFOFHaloProperties()

void vtkPLANLHaloFinder::ComputeFOFHaloProperties ( )

protected

Computes FOF halo properties, i.e., fofMass, fofXPos, etc.

§ InitializeHaloCenters()

void vtkPLANLHaloFinder::InitializeHaloCenters	(	vtkUnstructuredGrid *	haloCenters,
		unsigned int	N
	)

protected

Initializes the haloCenter output (output-2 of the filter) s.t.

the data-structure is ready to store all FOF properties for each of the N halos.

§ MarkHaloParticlesAndGetCenter()

void vtkPLANLHaloFinder::MarkHaloParticlesAndGetCenter	(	const unsigned int	halo,
		const int	internalHaloIdx,
		double	center[3],
		vtkUnstructuredGrid *	particles
	)

protected

Marks the halos of the given halo and computes the center using the prescribed center-finding method.

§ ResetHaloFinderInternals()

void vtkPLANLHaloFinder::ResetHaloFinderInternals ( )

protected

Resets halo-finder internal data-structures.

§ InitializeSODHaloArrays()

void vtkPLANLHaloFinder::InitializeSODHaloArrays ( vtkUnstructuredGrid * haloCenters )

protected

Initialize the SOD haloArrays.

Member Data Documentation

§ CenterDetectionAlgorithm

enum { ... } vtkPLANLHaloFinder::CenterDetectionAlgorithm

§ Controller

vtkMultiProcessController* vtkPLANLHaloFinder::Controller

protected

Definition at line 306 of file vtkPLANLHaloFinder.h.

§ NP

int vtkPLANLHaloFinder::NP

protected

Definition at line 308 of file vtkPLANLHaloFinder.h.

§ RL

float vtkPLANLHaloFinder::RL

protected

Definition at line 309 of file vtkPLANLHaloFinder.h.

§ Overlap

float vtkPLANLHaloFinder::Overlap

protected

Definition at line 310 of file vtkPLANLHaloFinder.h.

§ PMin

int vtkPLANLHaloFinder::PMin

protected

Definition at line 311 of file vtkPLANLHaloFinder.h.

§ BB

float vtkPLANLHaloFinder::BB

protected

Definition at line 312 of file vtkPLANLHaloFinder.h.

§ CenterFindingMethod

int vtkPLANLHaloFinder::CenterFindingMethod

protected

Definition at line 314 of file vtkPLANLHaloFinder.h.

§ ComputeSOD

int vtkPLANLHaloFinder::ComputeSOD

protected

Definition at line 315 of file vtkPLANLHaloFinder.h.

§ RhoC

float vtkPLANLHaloFinder::RhoC

protected

Definition at line 317 of file vtkPLANLHaloFinder.h.

§ SODMass

float vtkPLANLHaloFinder::SODMass

protected

Definition at line 318 of file vtkPLANLHaloFinder.h.

§ MinRadiusFactor

float vtkPLANLHaloFinder::MinRadiusFactor

protected

Definition at line 319 of file vtkPLANLHaloFinder.h.

§ MaxRadiusFactor

float vtkPLANLHaloFinder::MaxRadiusFactor

protected

Definition at line 320 of file vtkPLANLHaloFinder.h.

§ SODBins

int vtkPLANLHaloFinder::SODBins

protected

Definition at line 321 of file vtkPLANLHaloFinder.h.

§ MinFOFSize

int vtkPLANLHaloFinder::MinFOFSize

protected

Definition at line 322 of file vtkPLANLHaloFinder.h.

§ MinFOFMass

float vtkPLANLHaloFinder::MinFOFMass

protected

Definition at line 323 of file vtkPLANLHaloFinder.h.

§ Particles

HaloFinderInternals::ParticleData* vtkPLANLHaloFinder::Particles

protected

Definition at line 325 of file vtkPLANLHaloFinder.h.

§ Halos

HaloFinderInternals::HaloData* vtkPLANLHaloFinder::Halos

protected

Definition at line 326 of file vtkPLANLHaloFinder.h.

§ HaloFinder

cosmotk::CosmoHaloFinderP* vtkPLANLHaloFinder::HaloFinder

protected

Definition at line 327 of file vtkPLANLHaloFinder.h.

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

/builddir/build/BUILD/ParaView-v5.2.0/ParaViewCore/VTKExtensions/CosmoTools/vtkPLANLHaloFinder.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

§ Superclass

Member Enumeration Documentation

§ anonymous enum

Constructor & Destructor Documentation

§ vtkPLANLHaloFinder()

§ ~vtkPLANLHaloFinder()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ GetController()

§ SetController()

§ SetNP()

§ GetNP()

§ SetRL()

§ GetRL()

§ SetOverlap()

§ GetOverlap()

§ SetPMin()

§ GetPMin()

§ SetBB()

§ GetBB()

§ SetComputeSOD()

§ GetComputeSOD()

§ SetCenterFindingMethod()

§ GetCenterFindingMethod()

§ SetRhoC()

§ GetRhoC()

§ SetSODMass()

§ GetSODMass()

§ SetMinRadiusFactor()

§ GetMinRadiusFactor()

§ SetMaxRadiusFactor()

§ GetMaxRadiusFactor()

§ SetSODBins()

§ GetSODBins()

§ SetMinFOFSize()

§ GetMinFOFSize()

§ SetMinFOFMass()

§ GetMinFOFMass()

§ RequestData()

§ CheckOutputIntegrity()

§ ComputeFOFHalos()

§ ComputeSODHalos()

§ VectorizeData()

§ ComputeFOFHaloProperties()

§ InitializeHaloCenters()

§ MarkHaloParticlesAndGetCenter()

§ ResetHaloFinderInternals()

§ InitializeSODHaloArrays()

Member Data Documentation

§ CenterDetectionAlgorithm

§ Controller

§ NP

§ RL

§ Overlap

§ PMin

§ BB

§ CenterFindingMethod

§ ComputeSOD

§ RhoC

§ SODMass

§ MinRadiusFactor

§ MaxRadiusFactor

§ SODBins

§ MinFOFSize

§ MinFOFMass

§ Particles

§ Halos