diff --git a/dev/index.html b/dev/index.html index 5aa6508..5e45a4e 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · PhysicsTools.jl
Edit on GitHub

PhysicsTools

Documentation for PhysicsTools.

PhysicsTools.Types.Cascade — Type

Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.

source
PhysicsTools.Types.PEPlus — Type

Subtype of ParticleType, used to classify particles. pdg_code() can be used to find the corresponding particle PDF code.

source
PhysicsTools.Types.Particle — Type
Particle{T,PType<:ParticleType}

Struct containing information of a single particle

Fields

  • position::SVector{3,T}: Particle position given as a three dimensional static vector in detector coordinates
  • direction::SVector{3,T}: Particle direction of motion given as a three dimensional static vector in detector coordinates
  • time::T: Time of the event this particle corresponds to, given in unites of ns
  • energy::T: Total energy of the particle given in unites of GeV
  • length::T: Length of particle track given in unites of m
  • type::Type{PType}: Particle type, chosen from any ParticleType subtype (PEPlus, PEMinus, PGamma, PMuPlus, PMuMinus, PNuE, PNuMu, PNuTau, PNuEBar, PNuMuBar, PNuTauBar, PHadronShower, PLightSabre, PUnknown)
source
PhysicsTools.Types.Track — Type

Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.

source
PhysicsTools.Types.is_neutrino — Method
is_neutrino(particle)

Return true if particle is of any neutrino subtype (PNuE, PNuEBar, PNuMu, PNuMuBar, PNuTau, PNuTauBar), otherwise return false.

Arguments

  • particle::Type: Particle to check wheather is a neutrino.
source
PhysicsTools.Types.particle_shape — Method
particle_shape(partricle)

Return struct corresponding to shape of argument-particle's signature

Arguments

  • particle::Type: Particle to check shape of.
source
PhysicsTools.Types.pdg_code — Method
pdg_code(particle)

Return integer corresponding to the PDG code of a givern particle. ptypeforcode() can be used to find the struct of the corresponding particle.

Arguments

  • particle::Type: Particle to return PDG code of.
source
PhysicsTools.Types.ptype_for_code — Method
ptype_for_code(code::Integer)

Return particle struct corresponding to a given PDG code. pdg_code() can be used to find the PDG code of a corresponding particle.

Arguments

  • code::Integer: PDG code to get particle struct of.
source
PhysicsTools.Types.shift_particle — Method
shift_particle(particle::Particle, dist_along)

Shifts the given particle along its direction by the specified distance.

Arguments

  • particle::Particle: The particle to be shifted.
  • dist_along: The distance to shift the particle along its direction.

Returns

A new Particle object with the shifted position.

source
+Home · PhysicsTools.jl
Edit on GitHub

PhysicsTools

Documentation for PhysicsTools.

PhysicsTools.Types.Cascade — Type

Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.

source
PhysicsTools.Types.PEPlus — Type

Subtype of ParticleType, used to classify particles. pdg_code() can be used to find the corresponding particle PDF code.

source
PhysicsTools.Types.Particle — Type
Particle{T,PType<:ParticleType}

Struct containing information of a single particle

Fields

  • position::SVector{3,T}: Particle position given as a three dimensional static vector in detector coordinates
  • direction::SVector{3,T}: Particle direction of motion given as a three dimensional static vector in detector coordinates
  • time::T: Time of the event this particle corresponds to, given in unites of ns
  • energy::T: Total energy of the particle given in unites of GeV
  • length::T: Length of particle track given in unites of m
  • type::Type{PType}: Particle type, chosen from any ParticleType subtype (PEPlus, PEMinus, PGamma, PMuPlus, PMuMinus, PNuE, PNuMu, PNuTau, PNuEBar, PNuMuBar, PNuTauBar, PHadronShower, PLightSabre, PUnknown)
source
PhysicsTools.Types.Track — Type

Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.

source
PhysicsTools.Types.is_neutrino — Method
is_neutrino(particle)

Return true if particle is of any neutrino subtype (PNuE, PNuEBar, PNuMu, PNuMuBar, PNuTau, PNuTauBar), otherwise return false.

Arguments

  • particle::Type: Particle to check wheather is a neutrino.
source
PhysicsTools.Types.particle_shape — Method
particle_shape(partricle)

Return struct corresponding to shape of argument-particle's signature

Arguments

  • particle::Type: Particle to check shape of.
source
PhysicsTools.Types.pdg_code — Method
pdg_code(particle)

Return integer corresponding to the PDG code of a givern particle. ptypeforcode() can be used to find the struct of the corresponding particle.

Arguments

  • particle::Type: Particle to return PDG code of.
source
PhysicsTools.Types.ptype_for_code — Method
ptype_for_code(code::Integer)

Return particle struct corresponding to a given PDG code. pdg_code() can be used to find the PDG code of a corresponding particle.

Arguments

  • code::Integer: PDG code to get particle struct of.
source
PhysicsTools.Types.shift_particle! — Method
shift_particle(particle::Particle, dist_along)

Shifts the given particle along its direction by the specified distance.

Arguments

  • particle::Particle: The particle to be shifted.
  • dist_along: The distance to shift the particle along its direction.

Returns

A new Particle object with the shifted position.

source
diff --git a/dev/search/index.html b/dev/search/index.html index 29422c5..1c0887b 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · PhysicsTools.jl

Loading search...

    +Search · PhysicsTools.jl

    Loading search...

      diff --git a/dev/search_index.js b/dev/search_index.js index 828b09c..5b5fc62 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"","page":"Home","title":"Home","text":"CurrentModule = PhysicsTools","category":"page"},{"location":"#PhysicsTools","page":"Home","title":"PhysicsTools","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for PhysicsTools.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [PhysicsTools, PhysicsTools.Types, PhysicsTools.Utils, PhysicsTools.ProposalInterface]\nPages = [\"particle.jl\"]","category":"page"},{"location":"#PhysicsTools.Types.Cascade","page":"Home","title":"PhysicsTools.Types.Cascade","text":"Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.PEPlus","page":"Home","title":"PhysicsTools.Types.PEPlus","text":"Subtype of ParticleType, used to classify particles. pdg_code() can be used to find the corresponding particle PDF code.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.Particle","page":"Home","title":"PhysicsTools.Types.Particle","text":"Particle{T,PType<:ParticleType}\n\nStruct containing information of a single particle\n\nFields\n\nposition::SVector{3,T}: Particle position given as a three dimensional static vector in detector coordinates\ndirection::SVector{3,T}: Particle direction of motion given as a three dimensional static vector in detector coordinates\ntime::T: Time of the event this particle corresponds to, given in unites of ns\nenergy::T: Total energy of the particle given in unites of GeV\nlength::T: Length of particle track given in unites of m\ntype::Type{PType}: Particle type, chosen from any ParticleType subtype (PEPlus, PEMinus, PGamma, PMuPlus, PMuMinus, PNuE, PNuMu, PNuTau, PNuEBar, PNuMuBar, PNuTauBar, PHadronShower, PLightSabre, PUnknown)\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.Track","page":"Home","title":"PhysicsTools.Types.Track","text":"Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.is_neutrino-Union{Tuple{Particle{T, PType}}, Tuple{PType}, Tuple{T}} where {T, PType}","page":"Home","title":"PhysicsTools.Types.is_neutrino","text":"is_neutrino(particle)\n\nReturn true if particle is of any neutrino subtype (PNuE, PNuEBar, PNuMu, PNuMuBar, PNuTau, PNuTauBar), otherwise return false.\n\nArguments\n\nparticle::Type: Particle to check wheather is a neutrino.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.particle_shape-Union{Tuple{Particle{T, PType}}, Tuple{PType}, Tuple{T}} where {T, PType}","page":"Home","title":"PhysicsTools.Types.particle_shape","text":"particle_shape(partricle)\n\nReturn struct corresponding to shape of argument-particle's signature\n\nArguments\n\nparticle::Type: Particle to check shape of.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.pdg_code-Tuple{Type{e+}}","page":"Home","title":"PhysicsTools.Types.pdg_code","text":"pdg_code(particle)\n\nReturn integer corresponding to the PDG code of a givern particle. ptypeforcode() can be used to find the struct of the corresponding particle.\n\nArguments\n\nparticle::Type: Particle to return PDG code of.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.ptype_for_code-Tuple{Integer}","page":"Home","title":"PhysicsTools.Types.ptype_for_code","text":"ptype_for_code(code::Integer)\n\nReturn particle struct corresponding to a given PDG code. pdg_code() can be used to find the PDG code of a corresponding particle.\n\nArguments\n\ncode::Integer: PDG code to get particle struct of. \n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.shift_particle-Tuple{Particle, Any}","page":"Home","title":"PhysicsTools.Types.shift_particle","text":"shift_particle(particle::Particle, dist_along)\n\nShifts the given particle along its direction by the specified distance.\n\nArguments\n\nparticle::Particle: The particle to be shifted.\ndist_along: The distance to shift the particle along its direction.\n\nReturns\n\nA new Particle object with the shifted position.\n\n\n\n\n\n","category":"method"}] +[{"location":"","page":"Home","title":"Home","text":"CurrentModule = PhysicsTools","category":"page"},{"location":"#PhysicsTools","page":"Home","title":"PhysicsTools","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for PhysicsTools.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [PhysicsTools, PhysicsTools.Types, PhysicsTools.Utils, PhysicsTools.ProposalInterface]\nPages = [\"particle.jl\"]","category":"page"},{"location":"#PhysicsTools.Types.Cascade","page":"Home","title":"PhysicsTools.Types.Cascade","text":"Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.PEPlus","page":"Home","title":"PhysicsTools.Types.PEPlus","text":"Subtype of ParticleType, used to classify particles. pdg_code() can be used to find the corresponding particle PDF code.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.Particle","page":"Home","title":"PhysicsTools.Types.Particle","text":"Particle{T,PType<:ParticleType}\n\nStruct containing information of a single particle\n\nFields\n\nposition::SVector{3,T}: Particle position given as a three dimensional static vector in detector coordinates\ndirection::SVector{3,T}: Particle direction of motion given as a three dimensional static vector in detector coordinates\ntime::T: Time of the event this particle corresponds to, given in unites of ns\nenergy::T: Total energy of the particle given in unites of GeV\nlength::T: Length of particle track given in unites of m\ntype::Type{PType}: Particle type, chosen from any ParticleType subtype (PEPlus, PEMinus, PGamma, PMuPlus, PMuMinus, PNuE, PNuMu, PNuTau, PNuEBar, PNuMuBar, PNuTauBar, PHadronShower, PLightSabre, PUnknown)\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.Track","page":"Home","title":"PhysicsTools.Types.Track","text":"Subtype of ParticleShape, used to classify signatures in detector. PEPlus, PEMinus, PGamma and PHadronShower have the shape Cascade; while PMuMinus, PMuPlus and PLightSabre have the shape Track. particle_shape() can be used to return shape of particle signature.\n\n\n\n\n\n","category":"type"},{"location":"#PhysicsTools.Types.is_neutrino-Union{Tuple{Particle{T, PType}}, Tuple{PType}, Tuple{T}} where {T, PType}","page":"Home","title":"PhysicsTools.Types.is_neutrino","text":"is_neutrino(particle)\n\nReturn true if particle is of any neutrino subtype (PNuE, PNuEBar, PNuMu, PNuMuBar, PNuTau, PNuTauBar), otherwise return false.\n\nArguments\n\nparticle::Type: Particle to check wheather is a neutrino.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.particle_shape-Union{Tuple{Particle{T, PType}}, Tuple{PType}, Tuple{T}} where {T, PType}","page":"Home","title":"PhysicsTools.Types.particle_shape","text":"particle_shape(partricle)\n\nReturn struct corresponding to shape of argument-particle's signature\n\nArguments\n\nparticle::Type: Particle to check shape of.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.pdg_code-Tuple{Type{e+}}","page":"Home","title":"PhysicsTools.Types.pdg_code","text":"pdg_code(particle)\n\nReturn integer corresponding to the PDG code of a givern particle. ptypeforcode() can be used to find the struct of the corresponding particle.\n\nArguments\n\nparticle::Type: Particle to return PDG code of.\n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.ptype_for_code-Tuple{Integer}","page":"Home","title":"PhysicsTools.Types.ptype_for_code","text":"ptype_for_code(code::Integer)\n\nReturn particle struct corresponding to a given PDG code. pdg_code() can be used to find the PDG code of a corresponding particle.\n\nArguments\n\ncode::Integer: PDG code to get particle struct of. \n\n\n\n\n\n","category":"method"},{"location":"#PhysicsTools.Types.shift_particle!-Tuple{Particle, Any}","page":"Home","title":"PhysicsTools.Types.shift_particle!","text":"shift_particle(particle::Particle, dist_along)\n\nShifts the given particle along its direction by the specified distance.\n\nArguments\n\nparticle::Particle: The particle to be shifted.\ndist_along: The distance to shift the particle along its direction.\n\nReturns\n\nA new Particle object with the shifted position.\n\n\n\n\n\n","category":"method"}] }