{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Enumeration: ReferenceMode","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/readme"},"children":["API"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d"},"children":["geotoolkit3d"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5"},"children":["util"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5.well-2"},"children":["well"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5.well-2.logarray"},"children":["logarray"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5.well-2.logarray.logarrayutil"},"children":["LogArrayUtil"]}," / ReferenceMode"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"enumeration-referencemode","__idx":0},"children":["Enumeration: ReferenceMode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5.well-2.logarray"},"children":["logarray"]},".",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/modules/geotoolkit3d.util-5.well-2.logarray.logarrayutil"},"children":["LogArrayUtil"]},".ReferenceMode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enum to configure the LogArray sector 0 location.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","This enum provides several reference mechanism to determine where the sector 0 should be.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","For example it could be the sector pointing upward, or the sector pointing toward the North.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Enumeration Members"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/enums/geotoolkit3d.util-5.well-2.logarray.logarrayutil.referencemode#north"},"children":["North"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/enums/geotoolkit3d.util-5.well-2.logarray.logarrayutil.referencemode#up"},"children":["Up"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/solutions/geotoolkit/apis/enums/geotoolkit3d.util-5.well-2.logarray.logarrayutil.referencemode#upnorth"},"children":["UpNorth"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contents","__idx":2},"children":["Contents"]},{"$$mdtype":"Tag","name":"details","attributes":{"open":"true"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"fontSize":"1.25em","fontWeight":"bold"}},"children":["Enumeration Members"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"north","__idx":3},"children":["North"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["North"]}," = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use North as reference for sector 0.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","This is not suitable for horizontal trajectories pointing north."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"up","__idx":4},"children":["Up"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Up"]}," = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Up as reference for sector 0.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","This is not suitable for vertical trajectories."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"upnorth","__idx":5},"children":["UpNorth"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UpNorth"]}," = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This reference mode switches between Up or North depending on the inclination of the path.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","If the current section of the path has an inclination greater than the given angle, then Up will be used.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","As this check is done per 'section' of the LogArray, a 'twist' may appear on the resulting cylinder when the switch between Up/North reference occurs.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","This mode accepts a parameter to define the inclination angle threshold (in radians), the default value is 0.1745 (10 degrees).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","The angle is 0 for a vertical section and PI/2 for an horizontal section.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","To use a custom angle of 60 degrees for example, do geotoolkit3d.util.well.logarray.LogArrayUtil.ReferenceMode.UpNorth(1.0472)"]}]}]},"headings":[{"value":"Enumeration: ReferenceMode","id":"enumeration-referencemode","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Contents","id":"contents","depth":2},{"value":"North","id":"north","depth":4},{"value":"Up","id":"up","depth":4},{"value":"UpNorth","id":"upnorth","depth":4}],"frontmatter":{"seo":{"title":"Enumeration: ReferenceMode"}},"lastModified":"2026-02-11T19:54:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/geotoolkit/apis/enums/geotoolkit3d.util-5.well-2.logarray.logarrayutil.referencemode","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}