Gets a parameter from the VoxelSpace header.

Gets a parameter from the VoxelSpace header.

getParameter(vxsp, what)

# S4 method for VoxelSpace,character
getParameter(vxsp, what)

# S4 method for VoxelSpace,missing
getParameter(vxsp, what)

Arguments

vxsp

the VoxelSpace object

what

the name of the parameter. If missing returns all parameters.

Value

the parameter as a character

See also

VoxelSpace

Examples

# load a voxel file
vxsp <- readVoxelSpace(system.file("extdata", "tls_sample.vox", package = "AMAPVox"))
# show parameters name
names(getParameter(vxsp))
#>  [1] "nline"           "columnNames"     "mincorner"       "maxcorner"      
#>  [5] "dim"             "voxel.size"      "nsubvoxel"       "nrecordmax"     
#>  [9] "fraction-digits" "lad_type"        "type"            "max_pad"        
#> [13] "build-version"  
# retrieve 'mincorner' parameter
getParameter(vxsp, "mincorner")
#>    x    y    z 
#>  4.0  1.0 -1.5 
# all parameters
getParameter(vxsp)
#> $nline
#> [1] 12
#> 
#> $columnNames
#>  [1] "i"                               "j"                              
#>  [3] "k"                               "ground_distance"                
#>  [5] "nbEchos"                         "nbSampling"                     
#>  [7] "lgTotal"                         "lMeanTotal"                     
#>  [9] "sdLength"                        "angleMean"                      
#> [11] "bsPotential"                     "bsEntering"                     
#> [13] "bsIntercepted"                   "transmittance"                  
#> [15] "PadBVTotal"                      "attenuation_FPL_biasedMLE"      
#> [17] "attenuation_FPL_biasCorrection"  "attenuation_FPL_unbiasedMLE"    
#> [19] "weightedEffectiveFreepathLength" "weightedFreepathLength"         
#> [21] "attenuation_PPL_MLE"             "distLaser"                      
#> 
#> $mincorner
#>    x    y    z 
#>  4.0  1.0 -1.5 
#> 
#> $maxcorner
#>   x   y   z 
#> 7.5 4.0 3.5 
#> 
#> $dim
#>  x  y  z 
#>  7  6 10 
#> 
#> $voxel.size
#>   x   y   z 
#> 0.5 0.5 0.5 
#> 
#> $nsubvoxel
#> [1] "64"
#> 
#> $nrecordmax
#> [1] "0"
#> 
#> $`fraction-digits`
#> [1] "12"
#> 
#> $lad_type
#> [1] "Spherical"
#> 
#> $type
#> [1] "TLS"
#> 
#> $max_pad
#> [1] "5.0"
#> 
#> $`build-version`
#> [1] "1.8.1"
#>