Differences between revisions 24 and 25
Revision 24 as of 2009-06-26 13:10:47
Size: 8958
Editor: RalfDiener
Comment:
Revision 25 as of 2009-06-26 13:14:21
Size: 12414
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
||'''Documented''':|| if Doxygen/comments are already in (please check if it compiles):|| "yes" (./) , "partially" /!\ or "no" {X} || ||'''Documented/Beautified''':|| if Doxygen/comments are already in (please check if it compiles) and the code style has improved:|| "yes" (./) , "partially" /!\ or "no" {X} ||
Line 33: Line 33:
Line 34: Line 35:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 49: Line 50:
=== path = calibration/include ===
|| Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{calibration/include/DBEntryMaker.h}}} || ? || {X} || {X} || {X} ||
|| {{{calibration/include/DBWriter.h}}} || ? || {X} || {X} || {X} ||
|| {{{calibration/include/PedestalCalculator.h}}} || ? || {X} || {X} || {X} ||
Line 50: Line 57:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 53: Line 60:
|| {{{digitisation/include/EFieldVector.h}}} || ? || {X} || {X} || {X} ||
Line 54: Line 62:
|| {{{digitisation/include/HitDistributor.h}}} || ? || {X} || {X} || {X} ||
Line 58: Line 67:
|| {{{digitisation/include/TPCVoxel.h}}} || ? || {X} || {X} || {X} ||
Line 59: Line 69:
|| {{{digitisation/include/VoxelTPC.h}}} || ? || {X} || {X} || {X} ||
|| {{{digitisation/include/libgem.h}}} || ? || {X} || {X} || {X} ||
Line 61: Line 73:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 63: Line 75:
|| {{{reconstruction/include/ChannelCorrectionHandler.h}}} || ? || {X} || {X} || {X} ||
Line 68: Line 81:
|| {{{reconstruction/include/PedestalSubtractorProcessor.h}}} || RD || {X} || (./) || /!\ || || {{{reconstruction/include/LinearTrackRegression.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/MappingHandler.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/PedestalHandler.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/PedestalSubtractorProcessor.h}}} || ? || {X} || {X} || {X} ||
Line 70: Line 86:
|| {{{reconstruction/include/PulseFinderProcessor.h}}} || RD || {X} || (./) || /!\ || || {{{reconstruction/include/PulseFinderProcessor.h}}} || ? || {X} || {X} || {X} ||
Line 81: Line 97:
|| {{{reconstruction/include/TopoFinder.h}}} || ? || {X} || {X} || {X} ||
Line 83: Line 100:
|| {{{reconstruction/include/TrackFitterBase.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/TrackFitterChiSquare.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/TrackFitterChiSquarePads.h}}} || ? || {X} || {X} || {X} ||
|| {{{reconstruction/include/TrackFitterFactory.h}}} || ? || {X} || {X} || {X} ||
Line 88: Line 109:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{simulation/TPCCloudSimulation/include/ChargeSignal.h}}} || ? || {X} || {X} || {X} ||
|| {{{simulation/TPCCloudSimulation/include/ElectronCloud.h}}} || ? || {X} || {X} || {X} ||
Line 99: Line 122:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 103: Line 126:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 105: Line 128:
|| {{{tools/HepRepOutput/include/HepRepXMLWriter.h}}} || ? || {X} || {X} || {X} ||
Line 107: Line 131:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
Line 115: Line 139:
=== path = tools/IntersectionCalculator/include ===
|| Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{tools/IntersectionCalculator/include/IntersectionCalculator.h}}} || ? || {X} || {X} || {X} ||
Line 116: Line 144:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{tools/Field/include/ConstantUnidirectionalMagneticField.h}}} || ? || {X} || {X} || {X} ||
|| {{{tools/Field/include/DIDZMapMagneticField.h}}} || ? || {X} || {X} || {X} ||
|| {{{tools/Field/include/Field.h}}} || ? || {X} || {X} || {X} ||
Line 118: Line 149:
|| {{{tools/Field/include/IdealSolenoidField.h}}} || ? || {X} || {X} || {X} ||
|| {{{tools/Field/include/SolenoidZMapMagneticField.h}}} || ? || {X} || {X} || {X} ||

=== path = tools/LCObjectCopier/include ===
|| Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{tools/LCObjectCopier/include/LCObjectCopier.h}}} || ? || {X} || {X} || {X} ||

=== path = tpcconddata/include ===
|| Class || Who || Documented/Beautified || Multi-Module || Status ||
|| {{{tpcconddata/include/ADCChannelMapping.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/ChannelCorrection.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/FieldSetting.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/GasConditions.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/Pedestal.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/TPCConditions.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/TimePixMapListener.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/TimePixPixelMode.h}}} || ? || {X} || {X} || {X} ||
|| {{{tpcconddata/include/WeatherConditions.h}}} || ? || {X} || {X} || {X} ||
Line 120: Line 169:
|| processor || who || documented || multi-module || status || || Class || Who || Documented/Beautified || Multi-Module || Status ||

List of Processors in MarlinTPC

This is intended for the start of reviewing and learning MarlinTPC. Currently three persons are doing this: RD, SC and CR.

Who:

please enter your name/initials

Documented/Beautified:

if Doxygen/comments are already in (please check if it compiles) and the code style has improved:

"yes" (./) , "partially" /!\ or "no" {X}

Multi-module:

if it's multi-module capable :

"yes" (./) or "no" {X}

Status:

the overall status flag:

"Unknown" {X} , "will start (soon)" <!> , "in progress" /!\ , "done" (./)

Progress bar:

#

%

Total number of processors:

71

100

Unknown/Unchecked:

70

98.5

Number of documented:

1

1.5

Number of beautified:

1

1.5

Number of multi-module:

1

1.5

== list creation ==

In a downloaded MarlinTPC directory tree, issuing:

{{{for i in find  * -name include; do if ls $i/*rocessor* >& /dev/null;then echo "=== path = $i ==="; echo "|| processor || who || documented || multi-module || status ||"; for name in ls $i/*rocessor*; do echo "|| $name || || || || ||"; done;fi; done}}}

will yield the list of processors, that actually have "Processor" in their name.

The List

sorted by its relative path.

path = analysis/include

Class

Who

Documented/Beautified

Multi-Module

Status

analysis/include/BiasedResidualsProcessor.h

?

{X}

{X}

{X}

analysis/include/CutApplicationProcessor.h

?

{X}

{X}

{X}

analysis/include/HitAndTrackChargeProcessor.h

?

{X}

{X}

{X}

analysis/include/HitAndTrackCounterProcessor.h

?

{X}

{X}

{X}

analysis/include/LinearGeometricMeanResolutionProcessor.h

?

{X}

{X}

{X}

analysis/include/LinearThreePointResolutionProcessor.h

?

{X}

{X}

{X}

analysis/include/TimePixClusterSizeProcessor.h

?

{X}

{X}

{X}

analysis/include/TimePixOccupancyProcessor.h

?

{X}

{X}

{X}

analysis/include/TimePixTOTDistributionProcessor.h

?

{X}

{X}

{X}

analysis/include/TrackParametersDistributionProcessor.h

?

{X}

{X}

{X}

analysis/include/XYZDistributionProcessor.h

?

{X}

{X}

{X}

analysis/include/XYZDistributionTracksProcessor.h

?

{X}

{X}

{X}

analysis/include/ZBinTemplateProcessor.h

?

{X}

{X}

{X}

path = calibration/include

Class

Who

Documented/Beautified

Multi-Module

Status

calibration/include/DBEntryMaker.h

?

{X}

{X}

{X}

calibration/include/DBWriter.h

?

{X}

{X}

{X}

calibration/include/PedestalCalculator.h

?

{X}

{X}

{X}

path = digitisation/include

Class

Who

Documented/Beautified

Multi-Module

Status

digitisation/include/ChargeDistributionProcessor.h

?

{X}

{X}

{X}

digitisation/include/DriftProcessor.h

?

{X}

{X}

{X}

digitisation/include/EFieldVector.h

?

{X}

{X}

{X}

digitisation/include/GEMProcessor.h

?

{X}

{X}

{X}

digitisation/include/HitDistributor.h

?

{X}

{X}

{X}

digitisation/include/InhEFieldCalculationProcessor.h

?

{X}

{X}

{X}

digitisation/include/IonBackDriftProcessor.h

?

{X}

{X}

{X}

digitisation/include/IonsInVoxelsProcessor.h

?

{X}

{X}

{X}

digitisation/include/TPCElectronicsProcessor.h

?

{X}

{X}

{X}

digitisation/include/TPCVoxel.h

?

{X}

{X}

{X}

digitisation/include/TimePixDigitisationProcessor.h

?

{X}

{X}

{X}

digitisation/include/VoxelTPC.h

?

{X}

{X}

{X}

digitisation/include/libgem.h

?

{X}

{X}

{X}

path = reconstruction/include

Class

Who

Documented/Beautified

Multi-Module

Status

reconstruction/include/ADCPulseConverterProcessor.h

?

{X}

{X}

{X}

reconstruction/include/ChannelCorrectionHandler.h

?

{X}

{X}

{X}

reconstruction/include/ChannelMapperProcessor.h

?

{X}

{X}

{X}

reconstruction/include/CountsToPrimaryElectronsProcessor.h

?

{X}

{X}

{X}

reconstruction/include/GainCorrectorProcessor.h

?

{X}

{X}

{X}

reconstruction/include/HitTrackFinderTopoProcessor.h

?

{X}

{X}

{X}

reconstruction/include/LinearRegressionProcessor.h

?

{X}

{X}

{X}

reconstruction/include/LinearTrackRegression.h

?

{X}

{X}

{X}

reconstruction/include/MappingHandler.h

?

{X}

{X}

{X}

reconstruction/include/PedestalHandler.h

?

{X}

{X}

{X}

reconstruction/include/PedestalSubtractorProcessor.h

?

{X}

{X}

{X}

reconstruction/include/PhotodotReconstructionProcessor.h

?

{X}

{X}

{X}

reconstruction/include/PulseFinderProcessor.h

?

{X}

{X}

{X}

reconstruction/include/SimpleTrackSeederProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixClusterFinderProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixClusterProjectionSeparatorProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixHighTOTAnalyserProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixHitCenterCalculatorProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixHitSorterProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixMapHandlerProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixPixelInterpolationProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimePixZeroSuppressionProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TimeShiftCorrectorProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TopoFinder.h

?

{X}

{X}

{X}

reconstruction/include/TrackFinderHoughTrafoProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TrackFinderRectangularProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TrackFitterBase.h

?

{X}

{X}

{X}

reconstruction/include/TrackFitterChiSquare.h

?

{X}

{X}

{X}

reconstruction/include/TrackFitterChiSquarePads.h

?

{X}

{X}

{X}

reconstruction/include/TrackFitterFactory.h

?

{X}

{X}

{X}

reconstruction/include/TrackFitterLikelihoodProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TrackSeederProcessor.h

?

{X}

{X}

{X}

reconstruction/include/TrackerRawDataToDataConverterProcessor.h

?

{X}

{X}

{X}

path = simulation/TPCCloudSimulation/include

Class

Who

Documented/Beautified

Multi-Module

Status

simulation/TPCCloudSimulation/include/ChargeSignal.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/ElectronCloud.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/ElectronCloudChargeDepositProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/ElectronCloudDrifterProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/ElectronCloudGEMAmplificationProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/ElectronCloudHitReadoutPadsProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/PrimaryCloudIonisationProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/SignalCombinerProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/SignalDigitisationProcessor.h

?

{X}

{X}

{X}

simulation/TPCCloudSimulation/include/SignalShaperGaussianProcessor.h

?

{X}

{X}

{X}

path = simulation/include

Class

Who

Documented/Beautified

Multi-Module

Status

simulation/include/PrimaryIonisationProcessor.h

?

{X}

{X}

{X}

path = tools/HepRepOutput/include

Class

Who

Documented/Beautified

Multi-Module

Status

tools/HepRepOutput/include/HepRepOutputProcessor.h

?

{X}

{X}

{X}

tools/HepRepOutput/include/HepRepXMLWriter.h

?

{X}

{X}

{X}

path = tools/processors/include

Class

Who

Documented/Beautified

Multi-Module

Status

tools/processors/include/AidaPerEventCommitterProcessor.h

?

{X}

{X}

{X}

tools/processors/include/LoadDataFileProcessor.h

?

{X}

{X}

{X}

tools/processors/include/TPCHitToTrackerDataConverterProcessor.h

?

{X}

{X}

{X}

tools/processors/include/TimePixMaskCreaterProcessor.h

?

{X}

{X}

{X}

tools/processors/include/TimePixModeMapCreaterProcessor.h

?

{X}

{X}

{X}

tools/processors/include/TimePixReaderProcessor.h

?

{X}

{X}

{X}

path = tools/IntersectionCalculator/include

Class

Who

Documented/Beautified

Multi-Module

Status

tools/IntersectionCalculator/include/IntersectionCalculator.h

?

{X}

{X}

{X}

path = tools/Field/include

Class

Who

Documented/Beautified

Multi-Module

Status

tools/Field/include/ConstantUnidirectionalMagneticField.h

?

{X}

{X}

{X}

tools/Field/include/DIDZMapMagneticField.h

?

{X}

{X}

{X}

tools/Field/include/Field.h

?

{X}

{X}

{X}

tools/Field/include/GlobalFieldProcessor.h

?

{X}

{X}

{X}

tools/Field/include/IdealSolenoidField.h

?

{X}

{X}

{X}

tools/Field/include/SolenoidZMapMagneticField.h

?

{X}

{X}

{X}

path = tools/LCObjectCopier/include

Class

Who

Documented/Beautified

Multi-Module

Status

tools/LCObjectCopier/include/LCObjectCopier.h

?

{X}

{X}

{X}

path = tpcconddata/include

Class

Who

Documented/Beautified

Multi-Module

Status

tpcconddata/include/ADCChannelMapping.h

?

{X}

{X}

{X}

tpcconddata/include/ChannelCorrection.h

?

{X}

{X}

{X}

tpcconddata/include/FieldSetting.h

?

{X}

{X}

{X}

tpcconddata/include/GasConditions.h

?

{X}

{X}

{X}

tpcconddata/include/Pedestal.h

?

{X}

{X}

{X}

tpcconddata/include/TPCConditions.h

?

{X}

{X}

{X}

tpcconddata/include/TimePixMapListener.h

?

{X}

{X}

{X}

tpcconddata/include/TimePixPixelMode.h

?

{X}

{X}

{X}

tpcconddata/include/WeatherConditions.h

?

{X}

{X}

{X}

path = validation/processors/include

Class

Who

Documented/Beautified

Multi-Module

Status

validation/processors/include/ChargeOnPadsVisualisationProcessor.h

?

{X}

{X}

{X}

validation/processors/include/DumpEventProcessor.h

?

{X}

{X}

{X}

validation/processors/include/DumpHitsInTracksProcessor.h

?

{X}

{X}

{X}

validation/processors/include/DumpNTracksProcessor.h

?

{X}

{X}

{X}

validation/processors/include/DumpPadCentresProcessor.h

?

{X}

{X}

{X}

validation/processors/include/DumpResidualsProcessor.h

?

{X}

{X}

{X}

validation/processors/include/PrintEventNumberProcessor.h

?

{X}

{X}

{X}

validation/processors/include/SwapXYProcessor.h

?

{X}

{X}

{X}

validation/processors/include/TimePixEventHistoProcessor.h

?

{X}

{X}

{X}

MarlinTPCProcessorList (last edited 2012-01-17 12:12:03 by ChristophRosemann)