ParticleTypeClassifier (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.event.base.ParticleTypeClassifier

```
public final class ParticleTypeClassifier
extends Object
```
This class provides static utility methods for determining the type of a particle based on the PDGID. It based on the primary document on PDGIDs issued by the Particle Data Group and also on some code from the ATLAS LXR.
References
Version:

$Id: ParticleTypeClassifier.java,v 1.3 2011/08/24 18:51:17 jeremy Exp $

Author:

Jeremy McCormick

Constructor Summary

Constructors
Modifier Constructor and Description

private ParticleTypeClassifier()
Class is 100% static utility methods so it should not be instantiated.

Constructors
Modifier	Constructor and Description
`private`	`ParticleTypeClassifier()` Class is 100% static utility methods so it should not be instantiated.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) static int`	`flavor(int p)` Get the flavor of a hadron indicating its quark content.
`static boolean`	`isAntiNeutron(int p)` True if `p` is an antineutron.
`static boolean`	`isAntiProton(int p)` True if `p` is an antiproton.
`static boolean`	`isBHadron(int p)` True if `p` is a B hadron.
`static boolean`	`isBoson(int p)` True if `p` is a boson.
`static boolean`	`isBottomQuark(int p)` True if `p` is a bottom quark.
`static boolean`	`isCHadron(int p)` True if `p` is a C hadron.
`static boolean`	`isChargedKaon(int p)` True if `p` is a charged kaon.
`static boolean`	`isChargedLepton(int p)` True if `p` is a charged lepton.
`static boolean`	`isCharmQuark(int p)` True if `p` is a charm quark.
`static boolean`	`isDownQuark(int p)` True if `p` is a down quark.
`static boolean`	`isElectron(int p)` True if `p` is an electron.
`static boolean`	`isEM(int p)` True if `p` is an electron or photon.
`static boolean`	`isHadron(int p)` True if `p` is a hadron.
`static boolean`	`isHiggs(int p)` True if `p` is any type of Higgs boson.
`static boolean`	`isIon(int p)` True if `p` is an ion or nucleus.
`static boolean`	`isKaon(int p)` True if `p` is a kaon.
`static boolean`	`isLepton(int p)` True if `p` is a lepton.
`static boolean`	`isMuon(int p)` True if `p` is a muon.
`static boolean`	`isNeutralKaon(int p)` True if particle is a K0L or a K0S.
`static boolean`	`isNeutrino(int p)` True if `p` is a neutrino.
`static boolean`	`isNeutron(int p)` True if `p` is a neutron.
`static boolean`	`isPhoton(int p)` True if `p` is a photon.
`static boolean`	`isPositron(int p)` True if `p` is a positron.
`static boolean`	`isProton(int p)` True if `p` is a proton.
`static boolean`	`isQuark(int p)` True if `p` is a quark.
`static boolean`	`isSHadron(int p)` True if `p` is an S hadron.
`static boolean`	`isStrangeQuark(int p)` True if `p` is a strange quark.
`static boolean`	`isSUSY(int p)` True if `p` is a SUSY particle.
`static boolean`	`isTau(int p)` True if `p` is a tau.
`static boolean`	`isTechnicolor(int p)` True if `p` is a Technicolor particle.
`static boolean`	`isTopQuark(int p)` True if `p` is a top quark.
`static boolean`	`isUDHadron(int p)` True if `p` is an UD hadron.
`static boolean`	`isUpQuark(int p)` True if `p` is an up quark.
`static boolean`	`isWBoson(int p)` True if `p` is a W boson.
`static boolean`	`isZBoson(int p)` True if `p` is a Z boson.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParticleTypeClassifier
```
private ParticleTypeClassifier()
```
    Class is 100% static utility methods so it should not be instantiated.
- Method Detail
  - isLepton
```
public static boolean isLepton(int p)
```
    True if p is a lepton. Checks that p is between 11 and 18.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a lepton.
  - isChargedLepton
```
public static boolean isChargedLepton(int p)
```
    True if p is a charged lepton.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a charged lepton.
  - isNeutrino
```
public static boolean isNeutrino(int p)
```
    True if p is a neutrino. Checks that p is odd.
    
    Parameters:
    p -
    
    Returns:
  - isElectron
```
public static boolean isElectron(int p)
```
    True if p is an electron.
    
    Parameters:
    p -
    
    Returns:
  - isPositron
```
public static boolean isPositron(int p)
```
    True if p is a positron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a postitron.
  - isMuon
```
public static boolean isMuon(int p)
```
    True if p is a muon.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a muon.
  - isTau
```
public static boolean isTau(int p)
```
    True if p is a tau.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a tau.
  - isPhoton
```
public static boolean isPhoton(int p)
```
    True if p is a photon.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a photon.
  - isEM
```
public static boolean isEM(int p)
```
    True if p is an electron or photon.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an electron or photon.
  - isBoson
```
public static boolean isBoson(int p)
```
    True if p is a boson.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a boson.
  - isQuark
```
public static boolean isQuark(int p)
```
    True if p is a quark.
    
    Parameters:
    p -
    
    Returns:
  - isHadron
```
public static boolean isHadron(int p)
```
    True if p is a hadron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a hadron. FIXME: This may be incorrect. Needs to be checked.
  - isProton
```
public static boolean isProton(int p)
```
    True if p is a proton.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a proton.
  - isAntiProton
```
public static boolean isAntiProton(int p)
```
    True if p is an antiproton.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a antiproton.
  - isNeutron
```
public static boolean isNeutron(int p)
```
    True if p is a neutron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a neutron.
  - isAntiNeutron
```
public static boolean isAntiNeutron(int p)
```
    True if p is an antineutron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an antineutron.
  - isKaon
```
public static boolean isKaon(int p)
```
    True if p is a kaon.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an antineutron.
  - isChargedKaon
```
public static boolean isChargedKaon(int p)
```
    True if p is a charged kaon.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if particle is a charged kaon.
  - isUDHadron
```
public static boolean isUDHadron(int p)
```
    True if p is an UD hadron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an UD hadron.
  - isSHadron
```
public static boolean isSHadron(int p)
```
    True if p is an S hadron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an S hadron.
  - isCHadron
```
public static boolean isCHadron(int p)
```
    True if p is a C hadron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a C hadron.
  - isBHadron
```
public static boolean isBHadron(int p)
```
    True if p is a B hadron.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a B hadron.
  - isDownQuark
```
public static boolean isDownQuark(int p)
```
    True if p is a down quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a down quark.
  - isUpQuark
```
public static boolean isUpQuark(int p)
```
    True if p is an up quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a up quark.
  - isStrangeQuark
```
public static boolean isStrangeQuark(int p)
```
    True if p is a strange quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a strange quark.
  - isCharmQuark
```
public static boolean isCharmQuark(int p)
```
    True if p is a charm quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a charm quark.
  - isBottomQuark
```
public static boolean isBottomQuark(int p)
```
    True if p is a bottom quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a bottom quark.
  - isTopQuark
```
public static boolean isTopQuark(int p)
```
    True if p is a top quark.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a top quark.
  - isNeutralKaon
```
public static boolean isNeutralKaon(int p)
```
    True if particle is a K0L or a K0S.
    
    Parameters:
    p -
    
    Returns:
  - isIon
```
public static boolean isIon(int p)
```
    True if p is an ion or nucleus.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is an ion or nucleus. FIXME: This relies on the PDGID of ions and nuclei being 0, which may not be completely accurate. For instance, geantinos have a PDGID of 0 also, so it may not be correct for all cases.
  - isZBoson
```
public static boolean isZBoson(int p)
```
    True if p is a Z boson.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a Z boson.
  - isWBoson
```
public static boolean isWBoson(int p)
```
    True if p is a W boson.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a W boson.
  - isHiggs
```
public static boolean isHiggs(int p)
```
    True if p is any type of Higgs boson.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a Higgs boson.
  - isSUSY
```
public static boolean isSUSY(int p)
```
    True if p is a SUSY particle.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a SUSY particle.
  - isTechnicolor
```
public static boolean isTechnicolor(int p)
```
    True if p is a Technicolor particle.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    True if p is a Technicolor particle.
  - flavor
```
static int flavor(int p)
```
    Get the flavor of a hadron indicating its quark content. This method is only used internally.
    
    Parameters:
    p - The PDGID.
    
    Returns:
    The flavor of the particle.

Class ParticleTypeClassifier

References

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticleTypeClassifier

Method Detail

isLepton

isChargedLepton

isNeutrino

isElectron

isPositron

isMuon

isTau

isPhoton

isEM

isBoson

isQuark

isHadron

isProton

isAntiProton

isNeutron

isAntiNeutron

isKaon

isChargedKaon

isUDHadron

isSHadron

isCHadron

isBHadron

isDownQuark

isUpQuark

isStrangeQuark

isCharmQuark

isBottomQuark

isTopQuark

isNeutralKaon

isIon

isZBoson

isWBoson

isHiggs

isSUSY

isTechnicolor

flavor