Table of Contents
Start Using Dictionaries
Dictionaries are schema for Policies. You can validate a policy against a dictionary.
Ticket #951 is to convert all existing code to use dictionaries to validate policies.
It is a subtask of #872, validating policy files.
Existing Documentation of Policies
- PolicyHowto - step-by-step recipe for using policies, especially in pipeline stages
- PolicyFormats - reference for Policy file formats
- Doxygen for pex_policy package
- PolicyDesign (out of date; superceded by PolicyFormats)
Policy Schema Definitions
- Dictionary Files
- ap: StoreStageDictionary.paf, LoadStageDictionary.paf
- ip_diffim: ImageSubtractStageDictionary.paf, TemplateBBoxDictionary.paf
- meas_pipeline: SourceMeasurementStageDictionary, AddAndDetectStageDictionary.paf, SourceClassificationStageDictionary.paf, PsfDictionary.paf, RunModeDictionary.paf, WcsDeterminationStageDictionary.paf, SourceToDiaSourceStageDictionary.paf, PsfDeterminationStageDictionary.paf, DetectionDictionary.paf, SourceDetectionStageDictionary.paf
- meas_astrom: MeasureSourcesDictionary.paf
- Wiki pages
- Defined in comments
- ctrl_events: defined in EventTransmitter.cc, also used in EventReceiver.cc
Uses in code
The find command is executed below from the DMS dir in LSST code repository.
DefaultPolicyFile()
Should we change the signature to take a dictionary as well?
find . "(" -name "*.h" -o -name "*.py" -o -name "*.cpp" -o -name "*.cc" ")" -wholename "*trunk*" -print | xargs grep -Hn "DefaultPolicyFile" | grep -v "policyLib.py" | grep -v "policyLib_wrap.cc" | grep -v "pex/policy/trunk"
class PolicyConfigured
Interface that is apparently not used (?)
PolicyFile()
find . "(" -name "*.h" -o -name "*.py" -o -name "*.cpp" -o -name "*.cc" ")" -wholename "*trunk*" -print | xargs grep -H "PolicyFile(" | grep -v "DefaultPolicyFile(" | grep -v "pex/policy/trunk"
| file | # | line |
| ctrl/orca/trunk/python/lsst/ctrl/orca/provenance/Provenance.py | 89 | self._realRecordPolicyFile(self.db, policyFile, md5) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/provenance/Provenance.py | 90 | self._realRecordPolicyFile(self.globalDb, policyFile, md5) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/provenance/Provenance.py | 104 | def _realRecordPolicyFile(self, db, file, md5): |
| ip/diffim/trunk/tests/StageTest.py | 39 | diffimPolicyFile = pexPolicy.PolicyFile?(path) |
| meas/pipeline/trunk/tests/DetectTest.py | 44 | policyFile = policy.PolicyFile?(policyPath) |
| meas/pipeline/trunk/tests/PsfDeterminationTest.py | 43 | policyFile = policy.PolicyFile?(policyPath) |
| meas/pipeline/trunk/tests/PsfDeterminationTest.py | 47 | policyFile = policy.PolicyFile?(policyPath) |
| meas/pipeline/trunk/tests/PsfDeterminationTest.py | 51 | policyFile = policy.PolicyFile?(policyPath) |
Policy::createPolicy
find . "(" -name "*.h" -o -name "*.py" -o -name "*.cpp" -o -name "*.cc" ")" -wholename "*trunk*" -print | xargs grep -H "createPolicy" | grep -v "pex/policy/trunk" | grep -v "^\/\/"
| file | # | line |
| ctrl/dc3pipe/trunk/bin/launchDC3a.py | 105 | policy = Policy.createPolicy(policyFile, opts.repos) |
| ctrl/dc3pipe/trunk/bin/killPipeline.py | 67 | policy = Policy.createPolicy(cl.opts.prodpol, False) |
| ctrl/dc3pipe/trunk/bin/killPipeline.py | 80 | policy = Policy.createPolicy(cl.opts.platpol) |
| ctrl/dc3pipe/trunk/bin/eventGeneratorForCFHT.py | 119 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/dc3pipe/trunk/bin/eventGeneratorForCFHT.py | 203 | datatypePolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/dc3pipe/trunk/bin/eventGeneratorForCFHT.py | 213 | metadataPolicy = pexPolicy.Policy.createPolicy(metadataPolicy) |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfile.py | 54 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfile.py | 57 | metadataPolicy = pexPolicy.Policy.createPolicy(mdPolicyFileName) |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfile.py | 59 | dataPolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfileList.py | 120 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfileList.py | 191 | datatypePolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/dc3pipe/trunk/bin/eventFromFitsfileList.py | 201 | metadataPolicy = pexPolicy.Policy.createPolicy(metadataPolicy) |
| ctrl/events/trunk/examples/receive_3.py | 7 | p = policy.Policy.createPolicy("policies/activemq_policy.paf", 1) |
| ctrl/events/trunk/examples/transmit_3.py | 6 | p = policy.Policy.createPolicy("policies/activemq_policy.paf", 1) |
| ctrl/events/trunk/examples/receive_4.py | 7 | p = policy.Policy.createPolicy("policies/localsockets_policy.paf", 1) |
| ctrl/events/trunk/examples/transmit_4.py | 6 | p = policy.Policy.createPolicy("policies/localsockets_policy.paf", 1) |
| ctrl/mospipe/trunk/bin/launchMospipe.py | 105 | policy = Policy.createPolicy(policyFile, opts.repos) |
| ctrl/mospipe/trunk/bin/killPipeline.py | 67 | policy = Policy.createPolicy(cl.opts.prodpol, False) |
| ctrl/mospipe/trunk/bin/killPipeline.py | 80 | policy = Policy.createPolicy(cl.opts.platpol) |
| ctrl/mospipe/trunk/bin/eventGeneratorForCFHT.py | 119 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/mospipe/trunk/bin/eventGeneratorForCFHT.py | 203 | datatypePolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/mospipe/trunk/bin/eventGeneratorForCFHT.py | 213 | metadataPolicy = pexPolicy.Policy.createPolicy(metadataPolicy) |
| ctrl/mospipe/trunk/bin/eventFromFitsfile.py | 54 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/mospipe/trunk/bin/eventFromFitsfile.py | 57 | metadataPolicy = pexPolicy.Policy.createPolicy(mdPolicyFileName) |
| ctrl/mospipe/trunk/bin/eventFromFitsfile.py | 59 | dataPolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/mospipe/trunk/bin/eventFromFitsfileList.py | 120 | metadataPolicy = pexPolicy.Policy.createPolicy(mpf, |
| ctrl/mospipe/trunk/bin/eventFromFitsfileList.py | 191 | datatypePolicy = pexPolicy.Policy.createPolicy(cl.args[1]) |
| ctrl/mospipe/trunk/bin/eventFromFitsfileList.py | 201 | metadataPolicy = pexPolicy.Policy.createPolicy(metadataPolicy) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/AbePipelineManager.py | 156 | newPolicy = pol.Policy.createPolicy(polfile, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/AbePipelineManager.py | 196 | newPolicyObj = pol.Policy.createPolicy(newPolicyFile, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/SimplePipelineManager.py | 101 | newPolicy = pol.Policy.createPolicy(polfile, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/SimplePipelineManager.py | 134 | newPolicyObj = pol.Policy.createPolicy(newPolicyFile, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/PipelineManager.py | 162 | newPolicy = pol.Policy.createPolicy(filename, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/pipelines/PipelineManager.py | 175 | newPolicy = pol.Policy.createPolicy(filename, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/dbservers/DatabaseConfigurator.py | 136 | dbPolicyCredentials = Policy.createPolicy(dbPolicyCredentialsFile) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/provenance/Provenance.py | 92 | p = Policy.createPolicy(policyFile, False) |
| ctrl/orca/trunk/python/lsst/ctrl/orca/ProductionRunManager.py | 66 | self.policy = Policy.createPolicy(fullPolicyFilePath, False) |
| ctrl/dc2pipe/trunk/bin/launchDC2.py | 96 | pol = Policy.createPolicy(policyFile) |
| ctrl/dc2pipe/trunk/bin/killPipeline.py | 57 | policy = Policy.createPolicy(cl.opts.policy) |
| coadd/chisquared/trunk/examples/makeCoadd.py | 88 | makeCoaddPolicy = pexPolicy.Policy.createPolicy(makeCoaddPolicyPath) |
| coadd/psfmatched/trunk/examples/makeCoadd.py | 88 | makeCoaddPolicy = pexPolicy.Policy.createPolicy(makeCoaddPolicyPath) |
| coadd/kaiser/trunk/examples/makeBlurredCoadd.py | 123 | makeBlurredCoaddPolicy = pexPolicy.Policy.createPolicy(makeBlurredCoaddPolicyPath) |
| ip/diffim/trunk/examples/evaluateDC3a.py | 31 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/examples/testSizes.py | 142 | policy = Policy.createPolicy(policyPath) |
| ip/diffim/trunk/examples/subtractExposure.py | 71 | policy = Policy.createPolicy(policyPath) |
| ip/diffim/trunk/examples/testSizes3.py | 35 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/examples/testSizes2.py | 33 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/examples/subtractMaskedImage.py | 147 | policy = Policy.createPolicy(policyPath) |
| ip/diffim/trunk/tests/FindSetBits.py | 25 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/ConvolveAndSubtract.py | 31 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/PsfMatchingFunctor4.py | 35 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/PsfMatchingFunctor3.py | 33 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/GenerateBasisKernels.py | 25 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/PsfMatchingFunctor2.py | 33 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/TestPythonCode.py | 33 | policy = lsst.pex.policy.Policy.createPolicy(policyPath) |
| ip/diffim/trunk/tests/PsfMatchingFunctor.py | 28 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/SpatialModel.py | 37 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/ImageStatistics.py | 27 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/FindCounts.py | 25 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/diffim/trunk/tests/PsfMatchingFunctor5.py | 36 | self.policy = pexPolicy.Policy.createPolicy(diffimPolicy) |
| ip/isr/trunk/python/lsst/ip/isr/IsrStages.py | 60 | linearityPolicy = pexPolicy.Policy.createPolicy(linearizePath) |
| ip/isr/trunk/oldsrc/createChunkExposure.py | 55 | policy = pexPolicy.Policy.createPolicy(policyFile) |
| ip/isr/trunk/oldsrc/createCcdMaskedImage.py | 76 | policy = pexPolicy.Policy.createPolicy(policyFile) |
| ip/isr/trunk/tests/BiasAndDarkCorrection.py | 36 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/IsrStageTestSim.py | 39 | dc3MetadataPolicy = pexPolicy.Policy.createPolicy(dc3MetadataPath) |
| ip/isr/trunk/tests/IsrStageTestSim.py | 40 | simMetadataPolicy = pexPolicy.Policy.createPolicy(simMetadataPath) |
| ip/isr/trunk/tests/IsrStageTestSim.py | 41 | simCalibrationPolicy = pexPolicy.Policy.createPolicy(simCalibrationPath) |
| ip/isr/trunk/tests/IsrStageTestSim.py | 55 | self.policy.add('isrPolicy', pexPolicy.Policy.createPolicy(os.path.join(isrDir, 'pipeline', 'isrPolicy.paf'))) |
| ip/isr/trunk/tests/CrRejection.py | 36 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/Linearization.py | 34 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/TrimAndOverscanCorrection.py | 36 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/FlatAndIlluminationCorrection.py | 36 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/SaturationCorrection.py | 36 | self.policy = pexPolicy.Policy.createPolicy(InputIsrPolicy?) |
| ip/isr/trunk/tests/IsrStageTest.py | 40 | dc3MetadataPolicy = pexPolicy.Policy.createPolicy(dc3MetadataPath) |
| ip/isr/trunk/tests/IsrStageTest.py | 41 | cfhtMetadataPolicy = pexPolicy.Policy.createPolicy(cfhtMetadataPath) |
| ip/isr/trunk/tests/IsrStageTest.py | 42 | cfhtCalibrationPolicy = pexPolicy.Policy.createPolicy(cfhtCalibrationPath) |
| ip/isr/trunk/tests/IsrStageTest.py | 43 | ampPolicy = pexPolicy.Policy.createPolicy(ampPolicyPath) |
| ip/isr/trunk/tests/IsrStageTest.py | 57 | self.policy.add('isrPolicy', pexPolicy.Policy.createPolicy(os.path.join(isrDir, 'pipeline', 'isrPolicy.paf'))) |
| detection/trunk/python/lsst/detection/runDetection.py | 53 | policy = lsst.pex.policy.Policy.createPolicy(policyPath) |
| detection/trunk/python/lsst/detection/runDetection2.py | 29 | policy = lsst.pex.policy.Policy.createPolicy(policyPath) |
| dbserv/trunk/python/lsst/dbserv/policyReader.py | 16 | self.policyObj = pexPolicy.Policy.createPolicy(fullPath) |
| pex/harness/trunk/python/lsst/pex/harness/SimpleStageTester.py | 179 | policy = pexPolicy.Policy.createPolicy(policy) |
| pex/harness/trunk/python/lsst/pex/harness/Slice.py | 93 | topPolicy = policy.Policy.createPolicy(self.pipelinePolicyName, False) |
| pex/harness/trunk/python/lsst/pex/harness/Slice.py | 98 | p = policy.Policy.createPolicy(self.pipelinePolicyName, False) |
| pex/harness/trunk/python/lsst/pex/harness/Pipeline.py | 88 | topPolicy = policy.Policy.createPolicy(self.pipelinePolicyName) |
| pex/harness/trunk/python/lsst/pex/harness/Pipeline.py | 93 | p = policy.Policy.createPolicy(self.pipelinePolicyName) |
| pex/harness/trunk/examples/simpleStageTest.py | 33 | stagePolicy = pexPolicy.Policy.createPolicy(file) |
| pex/harness/trunk/examples/simpleStageTest.py | 89 | defpol = pexPolicy.Policy.createPolicy(file, file.getRepositoryPath()) |
| pex/harness/trunk/tests/TestIO.py | 8 | outputPolicy = lsst.pex.policy.Policy.createPolicy("tests/policy/output.policy") |
| pex/harness/trunk/tests/TestIO.py | 9 | inputPolicy = lsst.pex.policy.Policy.createPolicy("tests/policy/input.policy") |
| meas/algorithms/trunk/python/lsst/meas/algorithms/defects.py | 10 | badPixelsPolicy = policy.Policy.createPolicy(policyFile) |
| meas/algorithms/trunk/examples/MeasureSources.py | 171 | crPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/examples/MeasureSources.py | 240 | moPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/examples/MeasureSources.py | 281 | moPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/examples/CR.cc | 46 | pexPolicy::Policy::createPolicy(eups::productDir("meas_algorithms") + "/pipeline/CosmicRays.paf") |
| meas/algorithms/trunk/tests/Measure_1.py | 193 | crPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/tests/Measure_1.py | 243 | moPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/tests/CR.py | 70 | self.policy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| meas/algorithms/trunk/tests/PSFIO.py | 210 | moPolicy = policy.Policy.createPolicy(os.path.join(eups.productDir("meas_algorithms"), |
| cat/trunk/python/lsst/cat/policyReader.py | 16 | self.policyObj = pexPolicy.Policy.createPolicy(fullPath) |
Policy() constructor
find . "(" -name "*.h" -o -name "*.py" -o -name "*.cpp" -o -name "*.cc" ")" -wholename "*trunk*" -print | xargs grep -Hn " Policy(" | grep -v "pex/policy/trunk"
find . "(" -name "*.h" -o -name "*.py" -o -name "*.cpp" -o -name "*.cc" ")" -wholename "*trunk*" -print | xargs grep -Hn "\.Policy(" | grep -v "pex/policy/trunk"
Attachments
-
includes.txt
(18.8 KB) - added by bbaker
11 months ago.
Imports Policy and includes of policy.h and Policy.h
-
imports.txt
(24.2 KB) - added by bbaker
11 months ago.
files that use Policy C++ and Python interfaces
-
policies.txt
(20.8 KB) - added by bbaker
11 months ago.
policy files (*.paf) on the trunk
