| Title: | Tools for Reading AIDA Files |
|---|---|
| Description: | Read objects from the AIDA (<http://aida.freehep.org/>) file and make them available as dataframes in R. |
| Authors: | Andreas Pfeiffer <[email protected]> |
| Maintainer: | Andreas Pfeiffer <[email protected]> |
| License: | LGPL (>= 2) |
| Version: | 1.0.5 |
| Built: | 2024-12-10 06:54:08 UTC |
| Source: | CRAN |
retrieves the annotation of a given AIDA object by it's name from the given file
getAnnotation(fileName, objectName)getAnnotation(fileName, objectName)
fileName |
name of the AIDA file |
objectName |
name of the AIDA object for which the annotation is to be found |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") ann = getAnnotation(histoFile, '21')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") ann = getAnnotation(histoFile, '21')
retrieves a given 1D cloud by it's name from the given file and returns it as a data.frame
getCloud1D(fileName, cloudName)getCloud1D(fileName, cloudName)
fileName |
name of the AIDA file |
cloudName |
name of the AIDA 1D cloud to be returned |
histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c1d = getCloud1D(histoFile, '21')histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c1d = getCloud1D(histoFile, '21')
retrieves a given 2D cloud by it's name from the given file and returns it as a data.frame
getCloud2D(fileName, cloudName)getCloud2D(fileName, cloudName)
fileName |
name of the AIDA file |
cloudName |
name of the AIDA 2D cloud to be returned |
histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c2d = getCloud2D(histoFile, '30')histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c2d = getCloud2D(histoFile, '30')
retrieves a given 3D cloud by it's name from the given file and returns it as a data.frame
getCloud3D(fileName, cloudName)getCloud3D(fileName, cloudName)
fileName |
name of the AIDA file |
cloudName |
name of the AIDA 3D cloud to be returned |
histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c3d = getCloud3D(histoFile, '33')histoFile = system.file("extdata", "clouds.xml.gz", package="aidar") c3d = getCloud3D(histoFile, '33')
This function lists the context of a given AIDA file. The AIDA file should have been written out in "uncompressed" format which subsequently can be gzip compressed.
getFileInfo(fileName)getFileInfo(fileName)
fileName |
name of the AIDA file |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") info = getFileInfo(histoFile)histoFile = system.file("extdata", "histos.xml.gz", package="aidar") info = getFileInfo(histoFile)
retrieves a given 1D histogram by it's name from the given file and returns it as a data.frame
getHisto1D(fileName, histoName)getHisto1D(fileName, histoName)
fileName |
name of the AIDA file |
histoName |
name of the AIDA 1D histogram to be returned as a data.frame |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h1 = getHisto1D(histoFile, '1')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h1 = getHisto1D(histoFile, '1')
retrieves a given 2D histogram by it's name from the given file and returns it as a data.frame
getHisto2D(fileName, histoName)getHisto2D(fileName, histoName)
fileName |
name of the AIDA file |
histoName |
name of the AIDA 2D histogram to be returned as a data.frame |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h2 = getHisto2D(histoFile, '10')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h2 = getHisto2D(histoFile, '10')
retrieves a given 3D histogram by it's name from the given file and returns it as a data.frame
getHisto3D(fileName, histoName)getHisto3D(fileName, histoName)
fileName |
name of the AIDA file |
histoName |
name of the AIDA 3D histogram to be returned as a data.frame |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h3 = getHisto3D(histoFile, '13')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") h3 = getHisto3D(histoFile, '13')
retrieves a given 1D profile histogram by it's name from the given file and returns it as a data.frame
getProfile1D(fileName, histoName)getProfile1D(fileName, histoName)
fileName |
name of the AIDA file |
histoName |
name of the AIDA 1D profile histogram to be returned |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") p1d = getProfile1D(histoFile, 'Example profile (gauss)')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") p1d = getProfile1D(histoFile, 'Example profile (gauss)')
retrieves a given 2D profile histogram by it's name from the given file and returns it as a data.frame
getProfile2D(fileName, histoName)getProfile2D(fileName, histoName)
fileName |
name of the AIDA file |
histoName |
name of the AIDA 2D profile histogram to be returned |
histoFile = system.file("extdata", "histos.xml.gz", package="aidar") p2d = getProfile2D(histoFile, 'Example 2D profile (gauss)')histoFile = system.file("extdata", "histos.xml.gz", package="aidar") p2d = getProfile2D(histoFile, 'Example 2D profile (gauss)')
retrieves a given tuple by it's name from the given file and returns it as a data.frame
getTuple(fileName, tupName)getTuple(fileName, tupName)
fileName |
name of the AIDA file |
tupName |
name of the AIDA tuple to be returned |
tupleFile = system.file("extdata", "tuple.xml.gz", package="aidar") t100 = getTuple(tupleFile, '100')tupleFile = system.file("extdata", "tuple.xml.gz", package="aidar") t100 = getTuple(tupleFile, '100')