ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPANLHaloFinder Class Reference

Given an input a vtkUnstructuredGrid of points with arrays vx, vy, vz, and id, finds clumps of points (halos) using the cosmotools halo finder. More...

#include <vtkPANLHaloFinder.h>

Inherits vtkUnstructuredGridAlgorithm.

Public Types

enum  CenterFindingType { NONE = 0, MOST_BOUND_PARTICLE = 1, MOST_CONNECTED_PARTICLE = 2, HIST_CENTER_FINDING = 3 }
 

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetRunSubHaloFinder (bool)
 Turns on/off the subhalo finder part of the algorithm Default: Off. More...
 
virtual bool GetRunSubHaloFinder ()
 Turns on/off the subhalo finder part of the algorithm Default: Off. More...
 
virtual void RunSubHaloFinderOn ()
 Turns on/off the subhalo finder part of the algorithm Default: Off. More...
 
virtual void RunSubHaloFinderOff ()
 Turns on/off the subhalo finder part of the algorithm Default: Off. More...
 
virtual void SetRL (double)
 Gets/Sets RL, the physical coordinate box size Default: 256.0. More...
 
virtual double GetRL ()
 Gets/Sets RL, the physical coordinate box size Default: 256.0. More...
 
virtual void SetDistanceConvertFactor (double)
 Gets/Sets the distance conversion factor. More...
 
virtual double GetDistanceConvertFactor ()
 Gets/Sets the distance conversion factor. More...
 
virtual void SetMassConvertFactor (double)
 Gets/Sets the mass conversion factor. More...
 
virtual double GetMassConvertFactor ()
 Gets/Sets the mass conversion factor. More...
 
virtual void SetDeadSize (double)
 Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles. More...
 
virtual double GetDeadSize ()
 Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles. More...
 
virtual void SetParticleMass (float)
 Gets/Sets the particle mass. More...
 
virtual float GetParticleMass ()
 Gets/Sets the particle mass. More...
 
virtual void SetBB (double)
 Gets/Sets distance threshold for particles to be considered in the same halo. More...
 
virtual double GetBB ()
 Gets/Sets distance threshold for particles to be considered in the same halo. More...
 
virtual void SetAlphaFactor (double)
 Gets/Sets alpha factor. More...
 
virtual double GetAlphaFactor ()
 Gets/Sets alpha factor. More...
 
virtual void SetBetaFactor (double)
 Gets/Sets beta factor. More...
 
virtual double GetBetaFactor ()
 Gets/Sets beta factor. More...
 
virtual void SetNP (int)
 Gets/Sets NP Default: 1024. More...
 
virtual int GetNP ()
 Gets/Sets NP Default: 1024. More...
 
virtual void SetNMin (int)
 Gets/Sets the minimum number of close neighbors for a halo candidate to include a particle. More...
 
virtual int GetNMin ()
 Gets/Sets the minimum number of close neighbors for a halo candidate to include a particle. More...
 
virtual void SetPMin (int)
 Gets/Sets the minimum number of particles required for a halo candidate to be considered a halo and output Default: 10000. More...
 
virtual int GetPMin ()
 Gets/Sets the minimum number of particles required for a halo candidate to be considered a halo and output Default: 10000. More...
 
virtual void SetMinFOFSubhaloSize (long)
 Gets/Sets the minimum halo size to run the subhalo finder on. More...
 
virtual long GetMinFOFSubhaloSize ()
 Gets/Sets the minimum halo size to run the subhalo finder on. More...
 
virtual void SetMinCandidateSize (int)
 Gets/Sets the minimum size of a subhalo candidate Default: 200. More...
 
virtual int GetMinCandidateSize ()
 Gets/Sets the minimum size of a subhalo candidate Default: 200. More...
 
virtual void SetNumSPHNeighbors (int)
 Gets/Sets NumSPHNeighbors Default: 64. More...
 
virtual int GetNumSPHNeighbors ()
 Gets/Sets NumSPHNeighbors Default: 64. More...
 
virtual void SetNumNeighbors (int)
 Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20. More...
 
virtual int GetNumNeighbors ()
 Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20. More...
 
virtual void SetCenterFindingMode (int)
 Gets/Sets the center finding method used by the halo finder once halos are identified. More...
 
virtual int GetCenterFindingMode ()
 Gets/Sets the center finding method used by the halo finder once halos are identified. More...
 
virtual void SetSmoothingLength (double)
 Gets/Sets the smoothing length used by the center finders Default: 0.0. More...
 
virtual double GetSmoothingLength ()
 Gets/Sets the smoothing length used by the center finders Default: 0.0. More...
 
virtual void SetOmegaDM (double)
 Gets/Sets the OmegaDM parameter of the simulation. More...
 
virtual double GetOmegaDM ()
 Gets/Sets the OmegaDM parameter of the simulation. More...
 
virtual void SetOmegaNU (double)
 Gets/Sets the OmegaNU parameter of the simulation. More...
 
virtual double GetOmegaNU ()
 Gets/Sets the OmegaNU parameter of the simulation. More...
 
virtual void SetDeut (double)
 Gets/Sets the Deut parameter of the simulation. More...
 
virtual double GetDeut ()
 Gets/Sets the Deut parameter of the simulation. More...
 
virtual void SetHubble (double)
 Gets/Sets the Hubble parameter of the simulation. More...
 
virtual double GetHubble ()
 Gets/Sets the Hubble parameter of the simulation. More...
 
virtual void SetRedShift (double)
 Gets/Sets the current redshift. More...
 
virtual double GetRedShift ()
 Gets/Sets the current redshift. More...
 

Static Public Member Functions

static vtkPANLHaloFinderNew ()
 

Protected Member Functions

 vtkPANLHaloFinder ()
 
virtual ~vtkPANLHaloFinder ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int FillInputPortInformation (int port, vtkInformation *info)
 

Protected Attributes

double RL
 
double DistanceConvertFactor
 
double MassConvertFactor
 
double DeadSize
 
float ParticleMass
 
double BB
 
double AlphaFactor
 
double BetaFactor
 
int NP
 
int NMin
 
int PMin
 
long MinFOFSubhaloSize
 
int MinCandidateSize
 
int NumSPHNeighbors
 
int NumNeighbors
 
bool RunSubHaloFinder
 
int CenterFindingMode
 
double SmoothingLength
 
double OmegaNU
 
double OmegaDM
 
double Deut
 
double Hubble
 
double RedShift
 
vtkMultiProcessController * Controller
 
vtkInternals * Internal
 

Detailed Description

Given an input a vtkUnstructuredGrid of points with arrays vx, vy, vz, and id, finds clumps of points (halos) using the cosmotools halo finder.

The first output is a vtkUnstructuredGrid similar to the input but with the data array fof_halo_tag appended to indicate which halo a point lies in. The value will be -1 for points in no halo. Optionally, subhalo finding can be turned on which will find subhalos of all halos over a certain size. The subhalo id a point is in will be appended as the data array subhalo_tag.

The second output is a summary of halo properties such as mass, center of mass, center (computed via one of several algorithms), and net velocity. This vtkUnstructuredGrid has one point per halo.

The third output is empty unless subhalo finding is turned on. If subhalo finding is on, this output is similar to the second output except with data for each subhalo rather than each halo. It contains one point per subhalo.

Definition at line 44 of file vtkPANLHaloFinder.h.

Member Enumeration Documentation

◆ CenterFindingType

Enumerator
NONE 
MOST_BOUND_PARTICLE 
MOST_CONNECTED_PARTICLE 
HIST_CENTER_FINDING 

Definition at line 190 of file vtkPANLHaloFinder.h.

Constructor & Destructor Documentation

◆ vtkPANLHaloFinder()

vtkPANLHaloFinder::vtkPANLHaloFinder ( )
protected

◆ ~vtkPANLHaloFinder()

virtual vtkPANLHaloFinder::~vtkPANLHaloFinder ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkPANLHaloFinder* vtkPANLHaloFinder::New ( )
static

◆ PrintSelf()

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

◆ SetRunSubHaloFinder()

virtual void vtkPANLHaloFinder::SetRunSubHaloFinder ( bool  )
virtual

Turns on/off the subhalo finder part of the algorithm Default: Off.

◆ GetRunSubHaloFinder()

virtual bool vtkPANLHaloFinder::GetRunSubHaloFinder ( )
virtual

Turns on/off the subhalo finder part of the algorithm Default: Off.

◆ RunSubHaloFinderOn()

virtual void vtkPANLHaloFinder::RunSubHaloFinderOn ( )
virtual

Turns on/off the subhalo finder part of the algorithm Default: Off.

◆ RunSubHaloFinderOff()

virtual void vtkPANLHaloFinder::RunSubHaloFinderOff ( )
virtual

Turns on/off the subhalo finder part of the algorithm Default: Off.

◆ SetRL()

virtual void vtkPANLHaloFinder::SetRL ( double  )
virtual

Gets/Sets RL, the physical coordinate box size Default: 256.0.

◆ GetRL()

virtual double vtkPANLHaloFinder::GetRL ( )
virtual

Gets/Sets RL, the physical coordinate box size Default: 256.0.

◆ SetDistanceConvertFactor()

virtual void vtkPANLHaloFinder::SetDistanceConvertFactor ( double  )
virtual

Gets/Sets the distance conversion factor.

This is multiplied into all position coordinates before the halo finder is run. Default: 1.0

◆ GetDistanceConvertFactor()

virtual double vtkPANLHaloFinder::GetDistanceConvertFactor ( )
virtual

Gets/Sets the distance conversion factor.

This is multiplied into all position coordinates before the halo finder is run. Default: 1.0

◆ SetMassConvertFactor()

virtual void vtkPANLHaloFinder::SetMassConvertFactor ( double  )
virtual

Gets/Sets the mass conversion factor.

This is multiplied into the particle mass before the halo finder is run. Default: 1.0

◆ GetMassConvertFactor()

virtual double vtkPANLHaloFinder::GetMassConvertFactor ( )
virtual

Gets/Sets the mass conversion factor.

This is multiplied into the particle mass before the halo finder is run. Default: 1.0

◆ SetDeadSize()

virtual void vtkPANLHaloFinder::SetDeadSize ( double  )
virtual

Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles.

Default: 8.0

◆ GetDeadSize()

virtual double vtkPANLHaloFinder::GetDeadSize ( )
virtual

Gets/Sets the size of the ghost particle region around each process's particles to exchange when creating ghost particles.

Default: 8.0

◆ SetParticleMass()

virtual void vtkPANLHaloFinder::SetParticleMass ( float  )
virtual

Gets/Sets the particle mass.

For input datasets that do not have mass information the mass of each particle defaults to this value. Default: 1.307087181e+09

◆ GetParticleMass()

virtual float vtkPANLHaloFinder::GetParticleMass ( )
virtual

Gets/Sets the particle mass.

For input datasets that do not have mass information the mass of each particle defaults to this value. Default: 1.307087181e+09

◆ SetBB()

virtual void vtkPANLHaloFinder::SetBB ( double  )
virtual

Gets/Sets distance threshold for particles to be considered in the same halo.

This is measured in grid units on a NP x NP x NP grid. Default: 0.1679999998

◆ GetBB()

virtual double vtkPANLHaloFinder::GetBB ( )
virtual

Gets/Sets distance threshold for particles to be considered in the same halo.

This is measured in grid units on a NP x NP x NP grid. Default: 0.1679999998

◆ SetAlphaFactor()

virtual void vtkPANLHaloFinder::SetAlphaFactor ( double  )
virtual

Gets/Sets alpha factor.

This controls how aggressively small subhalos are grown. Alpha factor of 1.0 is the least aggressive Default: 1.0

◆ GetAlphaFactor()

virtual double vtkPANLHaloFinder::GetAlphaFactor ( )
virtual

Gets/Sets alpha factor.

This controls how aggressively small subhalos are grown. Alpha factor of 1.0 is the least aggressive Default: 1.0

◆ SetBetaFactor()

virtual void vtkPANLHaloFinder::SetBetaFactor ( double  )
virtual

Gets/Sets beta factor.

This controlls how saddle points between subhalos are treated. Larger values allow identification of smaller scale structures such as tails. Default: 0.0

◆ GetBetaFactor()

virtual double vtkPANLHaloFinder::GetBetaFactor ( )
virtual

Gets/Sets beta factor.

This controlls how saddle points between subhalos are treated. Larger values allow identification of smaller scale structures such as tails. Default: 0.0

◆ SetNP()

virtual void vtkPANLHaloFinder::SetNP ( int  )
virtual

Gets/Sets NP Default: 1024.

◆ GetNP()

virtual int vtkPANLHaloFinder::GetNP ( )
virtual

Gets/Sets NP Default: 1024.

◆ SetNMin()

virtual void vtkPANLHaloFinder::SetNMin ( int  )
virtual

Gets/Sets the minimum number of close neighbors for a halo candidate to include a particle.

Default: 1

◆ GetNMin()

virtual int vtkPANLHaloFinder::GetNMin ( )
virtual

Gets/Sets the minimum number of close neighbors for a halo candidate to include a particle.

Default: 1

◆ SetPMin()

virtual void vtkPANLHaloFinder::SetPMin ( int  )
virtual

Gets/Sets the minimum number of particles required for a halo candidate to be considered a halo and output Default: 10000.

◆ GetPMin()

virtual int vtkPANLHaloFinder::GetPMin ( )
virtual

Gets/Sets the minimum number of particles required for a halo candidate to be considered a halo and output Default: 10000.

◆ SetMinFOFSubhaloSize()

virtual void vtkPANLHaloFinder::SetMinFOFSubhaloSize ( long  )
virtual

Gets/Sets the minimum halo size to run the subhalo finder on.

Default: 10000

◆ GetMinFOFSubhaloSize()

virtual long vtkPANLHaloFinder::GetMinFOFSubhaloSize ( )
virtual

Gets/Sets the minimum halo size to run the subhalo finder on.

Default: 10000

◆ SetMinCandidateSize()

virtual void vtkPANLHaloFinder::SetMinCandidateSize ( int  )
virtual

Gets/Sets the minimum size of a subhalo candidate Default: 200.

◆ GetMinCandidateSize()

virtual int vtkPANLHaloFinder::GetMinCandidateSize ( )
virtual

Gets/Sets the minimum size of a subhalo candidate Default: 200.

◆ SetNumSPHNeighbors()

virtual void vtkPANLHaloFinder::SetNumSPHNeighbors ( int  )
virtual

Gets/Sets NumSPHNeighbors Default: 64.

◆ GetNumSPHNeighbors()

virtual int vtkPANLHaloFinder::GetNumSPHNeighbors ( )
virtual

Gets/Sets NumSPHNeighbors Default: 64.

◆ SetNumNeighbors()

virtual void vtkPANLHaloFinder::SetNumNeighbors ( int  )
virtual

Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20.

◆ GetNumNeighbors()

virtual int vtkPANLHaloFinder::GetNumNeighbors ( )
virtual

Gets/Sets the number of neighbors that are examined by the subhalo finder to determine local clumps near the each particle Default: 20.

◆ SetCenterFindingMode()

virtual void vtkPANLHaloFinder::SetCenterFindingMode ( int  )
virtual

Gets/Sets the center finding method used by the halo finder once halos are identified.

Default: NONE

◆ GetCenterFindingMode()

virtual int vtkPANLHaloFinder::GetCenterFindingMode ( )
virtual

Gets/Sets the center finding method used by the halo finder once halos are identified.

Default: NONE

◆ SetSmoothingLength()

virtual void vtkPANLHaloFinder::SetSmoothingLength ( double  )
virtual

Gets/Sets the smoothing length used by the center finders Default: 0.0.

◆ GetSmoothingLength()

virtual double vtkPANLHaloFinder::GetSmoothingLength ( )
virtual

Gets/Sets the smoothing length used by the center finders Default: 0.0.

◆ SetOmegaDM()

virtual void vtkPANLHaloFinder::SetOmegaDM ( double  )
virtual

Gets/Sets the OmegaDM parameter of the simulation.

Used by the center finding algorithms. Default: 0.26627

◆ GetOmegaDM()

virtual double vtkPANLHaloFinder::GetOmegaDM ( )
virtual

Gets/Sets the OmegaDM parameter of the simulation.

Used by the center finding algorithms. Default: 0.26627

◆ SetOmegaNU()

virtual void vtkPANLHaloFinder::SetOmegaNU ( double  )
virtual

Gets/Sets the OmegaNU parameter of the simulation.

Used by the center finding algorithms. Default: 0.0

◆ GetOmegaNU()

virtual double vtkPANLHaloFinder::GetOmegaNU ( )
virtual

Gets/Sets the OmegaNU parameter of the simulation.

Used by the center finding algorithms. Default: 0.0

◆ SetDeut()

virtual void vtkPANLHaloFinder::SetDeut ( double  )
virtual

Gets/Sets the Deut parameter of the simulation.

Used by the center finding algorithms. Default: 0.02258

◆ GetDeut()

virtual double vtkPANLHaloFinder::GetDeut ( )
virtual

Gets/Sets the Deut parameter of the simulation.

Used by the center finding algorithms. Default: 0.02258

◆ SetHubble()

virtual void vtkPANLHaloFinder::SetHubble ( double  )
virtual

Gets/Sets the Hubble parameter of the simulation.

Used by the center finding algorithms. Default: 0.673

◆ GetHubble()

virtual double vtkPANLHaloFinder::GetHubble ( )
virtual

Gets/Sets the Hubble parameter of the simulation.

Used by the center finding algorithms. Default: 0.673

◆ SetRedShift()

virtual void vtkPANLHaloFinder::SetRedShift ( double  )
virtual

Gets/Sets the current redshift.

Used by the center finding algorithms. Default: 0.0

◆ GetRedShift()

virtual double vtkPANLHaloFinder::GetRedShift ( )
virtual

Gets/Sets the current redshift.

Used by the center finding algorithms. Default: 0.0

◆ RequestInformation()

virtual int vtkPANLHaloFinder::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ RequestData()

virtual int vtkPANLHaloFinder::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ FillInputPortInformation()

int vtkPANLHaloFinder::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protected

Member Data Documentation

◆ RL

double vtkPANLHaloFinder::RL
protected

Definition at line 265 of file vtkPANLHaloFinder.h.

◆ DistanceConvertFactor

double vtkPANLHaloFinder::DistanceConvertFactor
protected

Definition at line 266 of file vtkPANLHaloFinder.h.

◆ MassConvertFactor

double vtkPANLHaloFinder::MassConvertFactor
protected

Definition at line 267 of file vtkPANLHaloFinder.h.

◆ DeadSize

double vtkPANLHaloFinder::DeadSize
protected

Definition at line 268 of file vtkPANLHaloFinder.h.

◆ ParticleMass

float vtkPANLHaloFinder::ParticleMass
protected

Definition at line 269 of file vtkPANLHaloFinder.h.

◆ BB

double vtkPANLHaloFinder::BB
protected

Definition at line 270 of file vtkPANLHaloFinder.h.

◆ AlphaFactor

double vtkPANLHaloFinder::AlphaFactor
protected

Definition at line 271 of file vtkPANLHaloFinder.h.

◆ BetaFactor

double vtkPANLHaloFinder::BetaFactor
protected

Definition at line 272 of file vtkPANLHaloFinder.h.

◆ NP

int vtkPANLHaloFinder::NP
protected

Definition at line 273 of file vtkPANLHaloFinder.h.

◆ NMin

int vtkPANLHaloFinder::NMin
protected

Definition at line 274 of file vtkPANLHaloFinder.h.

◆ PMin

int vtkPANLHaloFinder::PMin
protected

Definition at line 275 of file vtkPANLHaloFinder.h.

◆ MinFOFSubhaloSize

long vtkPANLHaloFinder::MinFOFSubhaloSize
protected

Definition at line 276 of file vtkPANLHaloFinder.h.

◆ MinCandidateSize

int vtkPANLHaloFinder::MinCandidateSize
protected

Definition at line 277 of file vtkPANLHaloFinder.h.

◆ NumSPHNeighbors

int vtkPANLHaloFinder::NumSPHNeighbors
protected

Definition at line 278 of file vtkPANLHaloFinder.h.

◆ NumNeighbors

int vtkPANLHaloFinder::NumNeighbors
protected

Definition at line 279 of file vtkPANLHaloFinder.h.

◆ RunSubHaloFinder

bool vtkPANLHaloFinder::RunSubHaloFinder
protected

Definition at line 281 of file vtkPANLHaloFinder.h.

◆ CenterFindingMode

int vtkPANLHaloFinder::CenterFindingMode
protected

Definition at line 284 of file vtkPANLHaloFinder.h.

◆ SmoothingLength

double vtkPANLHaloFinder::SmoothingLength
protected

Definition at line 285 of file vtkPANLHaloFinder.h.

◆ OmegaNU

double vtkPANLHaloFinder::OmegaNU
protected

Definition at line 286 of file vtkPANLHaloFinder.h.

◆ OmegaDM

double vtkPANLHaloFinder::OmegaDM
protected

Definition at line 287 of file vtkPANLHaloFinder.h.

◆ Deut

double vtkPANLHaloFinder::Deut
protected

Definition at line 288 of file vtkPANLHaloFinder.h.

◆ Hubble

double vtkPANLHaloFinder::Hubble
protected

Definition at line 289 of file vtkPANLHaloFinder.h.

◆ RedShift

double vtkPANLHaloFinder::RedShift
protected

Definition at line 290 of file vtkPANLHaloFinder.h.

◆ Controller

vtkMultiProcessController* vtkPANLHaloFinder::Controller
protected

Definition at line 292 of file vtkPANLHaloFinder.h.

◆ Internal

vtkInternals* vtkPANLHaloFinder::Internal
protected

Definition at line 294 of file vtkPANLHaloFinder.h.


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