Dips Scripting Reference Manual#
Prerequisites#
Before you begin, ensure you have the Dips program installed. You must have at minimum Version 9 in order to use this feature.
Python Environment#
There are two methods to run a script, which differ in the Python environment used:
- Running on RocScript Editor
Comes pre-installed with Dips and includes the Dips Python API library
For all-level users
- Running on your own Python environment
Requires downloading the Dips Python API library
For advanced users
Dips API Reference:
- dips
- dips package
- Submodules
- dips.AnchorPointVal module
- dips.AngleDataVal module
- dips.AnnotativeTools2DVal module
- dips.ApplicationManager module
- dips.ArrowToolEntityInfoRef module
- dips.ArrowToolEntityInfoVal module
- dips.AutomaticClusterAnalysisSettingsVal module
- dips.BuiltInDataDescriptors module
- dips.BuiltInDataFormatters module
- dips.CircularWindowVal module
- dips.ClusterWindowVal module
- dips.ColorSurrogateVal module
- dips.ConeToolEntityInfoRef module
- dips.ConeToolEntityInfoVal module
- dips.ConeVal module
- dips.ContourEntityVisibilityVal module
- dips.ContourOptionsVal module
- dips.CumulativeChartViewRef module
- dips.CumulativeChartViewVal module
- dips.CumulativePlotSettingsVal module
- dips.CurvedWindowVal module
- dips.CustomColumnCollectionVal module
- dips.CustomHistogramOptionsVal module
- dips.CustomRangeVal module
- dips.CustomRowRawDataVal module
- dips.DataDescriptorVal module
- dips.DataFilterRef module
- dips.DataFilterVal module
- dips.DataFormatterVal module
- dips.DataIdentifierVal module
- dips.DipsAPI_pb2 module
- dips.DipsAPI_pb2_grpc module
AppServiceAppServiceServicerAppServiceStubCumulativeChartServicesCumulativeChartServicesServicerCumulativeChartServicesStubEntityServicesEntityServicesServicerEntityServicesStubHistogramServicesHistogramServicesServicerHistogramServicesStubJointFrequencyChartServicesJointFrequencyChartServicesServicerJointFrequencyChartServicesStubJointSpacingChartServicesJointSpacingChartServicesServicerJointSpacingChartServicesStubProcessedDataManagerProcessedDataManagerServicerProcessedDataManagerStubProjStubServiceProjStubServiceServicerProjStubServiceStubQualitativeQuantitativeChartServicesQualitativeQuantitativeChartServicesServicerQualitativeQuantitativeChartServicesStubRQDAnalysisChartServicesRQDAnalysisChartServicesServicerRQDAnalysisChartServicesStubRosetteServicesRosetteServicesServicerRosetteServicesStubScatterChartServicesScatterChartServicesServicerScatterChartServicesStubSetServicesSetServicesServicerSetServicesStubStereonet2DServicesStereonet2DServicesServicerStereonet2DServicesStubStereonet3DServicesStereonet3DServicesServicerStereonet3DServicesStubadd_AppServiceServicer_to_server()add_CumulativeChartServicesServicer_to_server()add_EntityServicesServicer_to_server()add_HistogramServicesServicer_to_server()add_JointFrequencyChartServicesServicer_to_server()add_JointSpacingChartServicesServicer_to_server()add_ProcessedDataManagerServicer_to_server()add_ProjStubServiceServicer_to_server()add_QualitativeQuantitativeChartServicesServicer_to_server()add_RQDAnalysisChartServicesServicer_to_server()add_RosetteServicesServicer_to_server()add_ScatterChartServicesServicer_to_server()add_SetServicesServicer_to_server()add_Stereonet2DServicesServicer_to_server()add_Stereonet3DServicesServicer_to_server()add_nSameModuleReferenceAccessorServicer_to_server()nSameModuleReferenceAccessornSameModuleReferenceAccessorServicernSameModuleReferenceAccessorStub
- dips.DipsApp module
- dips.DiscontinuityDataVal module
- dips.EllipseToolEntityInfoRef module
- dips.EllipseToolEntityInfoVal module
- dips.FillFormatVal module
- dips.FoldEntityInfoRef module
- dips.FoldEntityInfoVal module
- dips.FoldEntityOptionsVal module
- dips.FoldEntityVisibilityRef module
- dips.FoldEntityVisibilityVal module
- dips.FoldWindowEntityInfoVal module
- dips.FoldWindowEntityVisibilityRef module
- dips.FoldWindowEntityVisibilityVal module
- dips.FreehandWindowVal module
- dips.FullDataFormatVal module
- dips.GlobalPlaneEntityVisibilityVal module
- dips.HistogramChartViewRef module
- dips.HistogramChartViewVal module
- dips.HistogramPlotSettingsVal module
- dips.IntersectionEntityVisibilityVal module
- dips.IntersectionOptionsVal module
- dips.IntervalVal module
- dips.JointFrequencyAnalysisSettingsVal module
- dips.JointFrequencyChartViewRef module
- dips.JointFrequencyChartViewVal module
- dips.JointSpacingAnalysisSettingsVal module
- dips.JointSpacingChartViewRef module
- dips.JointSpacingChartViewVal module
- dips.KinematicAnalysisEntityVisibilityVal module
- dips.KinematicAnalysisSettingsVal module
- dips.LatLongVal module
- dips.LengthDataVal module
- dips.LineFormatVal module
- dips.LineIntersectionCalculatorToolEntityInfoRef module
- dips.LineIntersectionCalculatorToolEntityInfoVal module
- dips.LineToolEntityInfoRef module
- dips.LineToolEntityInfoVal module
- dips.LineationVal module
- dips.MeasureAngleToolEntityInfoRef module
- dips.MeasureAngleToolEntityInfoVal module
- dips.OrientationDataSetRef module
- dips.OrientationDataSetVal module
- dips.PitchGridToolEntityInfoRef module
- dips.PitchGridToolEntityInfoVal module
- dips.PlaneEntityInfoRef module
- dips.PlaneEntityInfoVal module
- dips.PlaneEntityVisibilityRef module
- dips.PlaneEntityVisibilityVal module
- dips.PlaneIntersectionCalculatorToolEntityInfoRef module
- dips.PlaneIntersectionCalculatorToolEntityInfoVal module
- dips.PlaneOptionsVal module
- dips.PlaneVal module
- dips.PoleEntityOptionsVal module
- dips.PoleEntityVisibilityVal module
- dips.PolygonToolEntityInfoRef module
- dips.PolygonToolEntityInfoVal module
- dips.PolylineToolEntityInfoRef module
- dips.PolylineToolEntityInfoVal module
- dips.ProcessedDataVal module
- dips.ProjStubRef module
- dips.ProjStubVal module
- dips.ProtobufCollectionWrappers module
- dips.QualitativeQuantitativeAnalysisSettingsVal module
- dips.QualitativeQuantitativeChartViewRef module
- dips.QualitativeQuantitativeChartViewVal module
- dips.QuantitativeContourSettingsVal module
- dips.RQDAnalysisChartViewRef module
- dips.RQDAnalysisChartViewVal module
- dips.RQDAnalysisSettingsVal module
- dips.RectangleToolEntityInfoRef module
- dips.RectangleToolEntityInfoVal module
- dips.ReportingConventionResultVal module
- dips.RosettePresetOptionsVal module
- dips.RosetteSettingsVal module
- dips.RosetteViewRef module
- dips.RosetteViewVal module
- dips.ScatterChartViewRef module
- dips.ScatterChartViewVal module
- dips.ScatterPlotSettingsVal module
- dips.SetEntityInfoRef module
- dips.SetEntityInfoVal module
- dips.SetEntityOptionsVal module
- dips.SetEntityVisibilityRef module
- dips.SetEntityVisibilityVal module
- dips.SetStatisticsSettingsVal module
- dips.SetVersusSetVal module
- dips.SetWindowEntityInfoVal module
- dips.SetWindowEntityVisibilityRef module
- dips.SetWindowEntityVisibilityVal module
- dips.StatisticalDistributionFilterVal module
- dips.Stereonet2DPresetOptionsVal module
- dips.Stereonet2DViewRef module
- dips.Stereonet2DViewVal module
- dips.Stereonet3DPresetOptionsVal module
- dips.Stereonet3DViewRef module
- dips.Stereonet3DViewVal module
- dips.StereonetOverlayEntityVisibilityVal module
- dips.StereonetOverlaySettingsVal module
- dips.StereonetProjectionModeVal module
- dips.SurveyDataVal module
- dips.SymbolDisplaySettingVal module
- dips.SymbolicSettingsVal module
- dips.TextFormatVal module
- dips.TextToolEntityInfoRef module
- dips.TextToolEntityInfoVal module
- dips.TraverseEntityOptionsVal module
- dips.TraverseEntityVisibilityRef module
- dips.TraverseEntityVisibilityVal module
- dips.TrendLineToolEntityInfoRef module
- dips.TrendLineToolEntityInfoVal module
- dips.TrendPlungeVal module
- dips.UnitSystemResultVal module
- dips.UserPlaneEntityOptionsVal module
- dips.ValidatableResultVal module
- dips.ValidatableResult_ProtoReference_ArrowToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_ConeToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_EllipseToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_FoldEntityInfoVal module
- dips.ValidatableResult_ProtoReference_LineIntersectionCalculatorToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_LineToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_MeasureAngleToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_OrientationDataSetVal module
- dips.ValidatableResult_ProtoReference_PitchGridToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_PlaneEntityInfoVal module
- dips.ValidatableResult_ProtoReference_PlaneIntersectionCalculatorToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_PolygonToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_PolylineToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_RectangleToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_SetEntityInfoVal module
- dips.ValidatableResult_ProtoReference_TextToolEntityInfoVal module
- dips.ValidatableResult_ProtoReference_TrendLineToolEntityInfoVal module
- dips.ValidationErrorVal module
- dips.Vector2DVal module
- dips.Vector3Val module
- dips.VectorDensityContourSettingsVal module
- dips.WeightingSettingsVal module
- dips.WrappedFreehandWindowVal module
- Module contents
- Submodules
- dips package