[{"data":1,"prerenderedAt":513},["ShallowReactive",2],{"page-\u002Futils\u002Fapi\u002Ffunctions\u002FgetSampleDepth":3,"navigation":126},{"collection":4,"page":5},"docs_en",{"id":6,"title":7,"body":8,"description":116,"extension":117,"meta":118,"navigation":120,"path":121,"rawbody":122,"seo":123,"stem":124,"__hash__":125},"docs_en\u002Futils\u002Fapi\u002Ffunctions\u002FgetSampleDepth.md","getSampleDepth",{"type":9,"value":10,"toc":106},"minimark",[11,41,74,79,82,87,89,94,98],[12,13,14],"blockquote",{},[15,16,17,20,21,25,26,29,30,37,38],"p",{},[18,19,7],"strong",{},"(",[22,23,24],"code",{},"well",", ",[22,27,28],{},"sample","): ",[31,32,34],"a",{"href":33},"\u002Futils\u002Fapi\u002Ftype-aliases\u002FSampleDepth",[22,35,36],{},"SampleDepth"," | ",[22,39,40],{},"undefined",[15,42,43,44,47,48,51,52,55,56,59,60,63,64,67,68,70,71,73],{},"Effective depth of a sample. A sample taken at the production pump\n(",[22,45,46],{},"sampling_point.pump_installation_id",") takes the pump's ",[22,49,50],{},"intake_depth",";\notherwise ",[22,53,54],{},"sampling_point.depth"," gives a point and ",[22,57,58],{},"from","\u002F",[22,61,62],{},"to"," an interval\n(",[22,65,66],{},"depth"," wins on the malformed combination of both). ",[22,69,40],{}," when the\ndepth is unknown (no sampling point, a wellhead tap, an unresolved pump or\na pump without ",[22,72,50],{},").",[75,76,78],"h2",{"id":77},"parameters","Parameters",[80,81,24],"h3",{"id":24},[15,83,84],{},[22,85,86],{},"Well",[80,88,28],{"id":28},[15,90,91],{},[22,92,93],{},"WaterSample",[75,95,97],{"id":96},"returns","Returns",[15,99,100,37,104],{},[31,101,102],{"href":33},[22,103,36],{},[22,105,40],{},{"title":107,"searchDepth":108,"depth":108,"links":109},"",2,[110,115],{"id":77,"depth":108,"text":78,"children":111},[112,114],{"id":24,"depth":113,"text":24},3,{"id":28,"depth":113,"text":28},{"id":96,"depth":108,"text":97},"Effective depth of a sample. A sample taken at the production pump (samplingpoint.pumpinstallationid) takes the pump's intakedepth; otherwise samplingpoint.depth gives a point and from\u002Fto an interval (depth wins on the malformed combination of both). undefined when the depth is unknown (no sampling ","md",{"generated":119},true,false,"\u002Futils\u002Fapi\u002Ffunctions\u002FgetSampleDepth","---\npath: \"\u002Futils\u002Fapi\u002Ffunctions\u002FgetSampleDepth\"\ntitle: getSampleDepth\ndescription: \"Effective depth of a sample. A sample taken at the production pump (samplingpoint.pumpinstallationid) takes the pump's intakedepth; otherwise samplingpoint.depth gives a point and from\u002Fto an interval (depth wins on the malformed combination of both). undefined when the depth is unknown (no sampling \"\ngenerated: true\nnavigation: false\n---\n\n> **getSampleDepth**(`well`, `sample`): [`SampleDepth`](\u002Futils\u002Fapi\u002Ftype-aliases\u002FSampleDepth) \\| `undefined`\n\nEffective depth of a sample. A sample taken at the production pump\n(`sampling_point.pump_installation_id`) takes the pump's `intake_depth`;\notherwise `sampling_point.depth` gives a point and `from`\u002F`to` an interval\n(`depth` wins on the malformed combination of both). `undefined` when the\ndepth is unknown (no sampling point, a wellhead tap, an unresolved pump or\na pump without `intake_depth`).\n\n## Parameters\n\n### well\n\n`Well`\n\n### sample\n\n`WaterSample`\n\n## Returns\n\n[`SampleDepth`](\u002Futils\u002Fapi\u002Ftype-aliases\u002FSampleDepth) \\| `undefined`\n",{"title":7,"description":116},"utils\u002Fapi\u002Ffunctions\u002FgetSampleDepth","n5y9c5kNMvfmWDETJGf0H9Hdj5b7Kjy2ffbLcNrrtDc",{"docs_en":127,"spec":444,"changelogs":494},[128,148,167,222,332,386],{"title":129,"path":130,"stem":131,"children":132},"Ai","\u002Fai","ai",[133,136,140,144],{"title":134,"path":130,"stem":135},"Introduction","ai\u002Findex",{"title":137,"path":138,"stem":139},"Converting reports with an assistant","\u002Fai\u002Fconversion-skill","ai\u002Fconversion-skill",{"title":141,"path":142,"stem":143},"llms.txt and Markdown pages","\u002Fai\u002Fllms","ai\u002Fllms",{"title":145,"path":146,"stem":147},"MCP server","\u002Fai\u002Fmcp","ai\u002Fmcp",{"title":149,"path":150,"stem":151,"children":152},"Contributing","\u002Fcontributing","contributing",[153,155,159,163],{"title":134,"path":150,"stem":154},"contributing\u002Findex",{"title":156,"path":157,"stem":158},"Writing docs","\u002Fcontributing\u002Fwriting-docs","contributing\u002F1.writing-docs",{"title":160,"path":161,"stem":162},"Update rules","\u002Fcontributing\u002Fupdate-rules","contributing\u002F2.update-rules",{"title":164,"path":165,"stem":166},"Content components","\u002Fcontributing\u002Fcomponents","contributing\u002Fcomponents",{"title":168,"path":169,"stem":170,"children":171},"Core","\u002Fcore","core",[172,174,187,216],{"title":134,"path":169,"stem":173},"core\u002Findex",{"title":175,"path":176,"stem":177,"children":178,"page":120},"Getting Started","\u002Fcore\u002Fgetting-started","core\u002F1.getting-started",[179,183],{"title":180,"path":181,"stem":182},"Installation","\u002Fcore\u002Fgetting-started\u002Finstallation","core\u002F1.getting-started\u002F1.installation",{"title":184,"path":185,"stem":186},"First use","\u002Fcore\u002Fgetting-started\u002Ffirst-use","core\u002F1.getting-started\u002F2.first-use",{"title":188,"path":189,"stem":190,"children":191,"page":120},"Guides","\u002Fcore\u002Fguides","core\u002F2.guides",[192,196,200,204,208,212],{"title":193,"path":194,"stem":195},"Parsing and validating","\u002Fcore\u002Fguides\u002Fparsing-and-validating","core\u002F2.guides\u002F1.parsing-and-validating",{"title":197,"path":198,"stem":199},"Serializing and sharing","\u002Fcore\u002Fguides\u002Fserializing-and-sharing","core\u002F2.guides\u002F2.serializing-and-sharing",{"title":201,"path":202,"stem":203},"Unit conversion","\u002Fcore\u002Fguides\u002Funit-conversion","core\u002F2.guides\u002F3.unit-conversion",{"title":205,"path":206,"stem":207},"Vocabularies and textures","\u002Fcore\u002Fguides\u002Fvocabularies-and-textures","core\u002F2.guides\u002F4.vocabularies-and-textures",{"title":209,"path":210,"stem":211},"Water quality vocabulary","\u002Fcore\u002Fguides\u002Fwater-quality-vocabulary","core\u002F2.guides\u002F5.water-quality-vocabulary",{"title":213,"path":214,"stem":215},"Versions and time zones","\u002Fcore\u002Fguides\u002Fversions-and-time-zones","core\u002F2.guides\u002F6.versions-and-time-zones",{"title":217,"path":218,"stem":219,"children":220},"API reference","\u002Fcore\u002Fapi","core\u002Fapi\u002Findex",[221],{"title":217,"path":218,"stem":219},{"title":223,"path":224,"stem":225,"children":226},"Format","\u002Fformat","format",[227,229,249,278,302,322,328],{"title":134,"path":224,"stem":228},"format\u002Findex",{"title":175,"path":230,"stem":231,"children":232,"page":120},"\u002Fformat\u002Fgetting-started","format\u002F1.getting-started",[233,237,241,245],{"title":234,"path":235,"stem":236},"What is .well?","\u002Fformat\u002Fgetting-started\u002Fwhat-is-well","format\u002F1.getting-started\u002F1.what-is-well",{"title":238,"path":239,"stem":240},"For geologists","\u002Fformat\u002Fgetting-started\u002Ffor-geologists","format\u002F1.getting-started\u002F2.for-geologists",{"title":242,"path":243,"stem":244},"For developers","\u002Fformat\u002Fgetting-started\u002Ffor-developers","format\u002F1.getting-started\u002F3.for-developers",{"title":246,"path":247,"stem":248},"Your first .well file","\u002Fformat\u002Fgetting-started\u002Ffirst-well-file","format\u002F1.getting-started\u002F4.first-well-file",{"title":250,"path":251,"stem":252,"children":253,"page":120},"Concepts","\u002Fformat\u002Fconcepts","format\u002F2.concepts",[254,258,262,266,270,274],{"title":255,"path":256,"stem":257},"Depths and intervals","\u002Fformat\u002Fconcepts\u002Fdepths-and-intervals","format\u002F2.concepts\u002F1.depths-and-intervals",{"title":259,"path":260,"stem":261},"Units and precision","\u002Fformat\u002Fconcepts\u002Funits-and-precision","format\u002F2.concepts\u002F2.units-and-precision",{"title":263,"path":264,"stem":265},"Vocabularies","\u002Fformat\u002Fconcepts\u002Fvocabularies","format\u002F2.concepts\u002F3.vocabularies",{"title":267,"path":268,"stem":269},"Profiles","\u002Fformat\u002Fconcepts\u002Fprofiles","format\u002F2.concepts\u002F4.profiles",{"title":271,"path":272,"stem":273},"Versions and deprecation","\u002Fformat\u002Fconcepts\u002Fversions-and-deprecation","format\u002F2.concepts\u002F5.versions-and-deprecation",{"title":275,"path":276,"stem":277},"Extensibility","\u002Fformat\u002Fconcepts\u002Fextensibility","format\u002F2.concepts\u002F6.extensibility",{"title":188,"path":279,"stem":280,"children":281,"page":120},"\u002Fformat\u002Fguides","format\u002F3.guides",[282,286,290,294,298],{"title":283,"path":284,"stem":285},"Writing a .well by hand","\u002Fformat\u002Fguides\u002Fwriting-by-hand","format\u002F3.guides\u002F1.writing-by-hand",{"title":287,"path":288,"stem":289},"Converting a report","\u002Fformat\u002Fguides\u002Fconverting-a-report","format\u002F3.guides\u002F2.converting-a-report",{"title":291,"path":292,"stem":293},"Validating","\u002Fformat\u002Fguides\u002Fvalidating","format\u002F3.guides\u002F3.validating",{"title":295,"path":296,"stem":297},"Extending for your own needs","\u002Fformat\u002Fguides\u002Fextending","format\u002F3.guides\u002F4.extending",{"title":299,"path":300,"stem":301},"Building an editor or database on .well","\u002Fformat\u002Fguides\u002Fbuilding-on-well","format\u002F3.guides\u002F5.building-on-well",{"title":303,"path":304,"stem":305,"children":306},"Overview","\u002Fformat\u002Freference","format\u002F4.reference\u002Findex",[307,308,312,316],{"title":303,"path":304,"stem":305},{"title":309,"path":310,"stem":311},"JSON Schema","\u002Fformat\u002Freference\u002Fjson-schema","format\u002F4.reference\u002F1.json-schema",{"title":313,"path":314,"stem":315},"Example wells","\u002Fformat\u002Freference\u002Fexamples","format\u002F4.reference\u002F2.examples",{"title":317,"path":318,"stem":319,"children":320},"Object reference","\u002Fformat\u002Freference\u002Fobjects","format\u002Freference\u002Fobjects\u002Findex",[321],{"title":317,"path":318,"stem":319},{"title":323,"path":324,"stem":325,"children":326},"About the spec","\u002Fformat\u002Fspec","format\u002F5.spec\u002Findex",[327],{"title":323,"path":324,"stem":325},{"title":329,"path":330,"stem":331},"Changelog","\u002Fformat\u002Fchangelog","format\u002F6.changelog",{"title":333,"path":334,"stem":335,"children":336},"Render","\u002Frender","render",[337,339,349,381],{"title":134,"path":334,"stem":338},"render\u002Findex",{"title":175,"path":340,"stem":341,"children":342,"page":120},"\u002Frender\u002Fgetting-started","render\u002F1.getting-started",[343,346],{"title":180,"path":344,"stem":345},"\u002Frender\u002Fgetting-started\u002Finstallation","render\u002F1.getting-started\u002F1.installation",{"title":184,"path":347,"stem":348},"\u002Frender\u002Fgetting-started\u002Ffirst-use","render\u002F1.getting-started\u002F2.first-use",{"title":188,"path":350,"stem":351,"children":352,"page":120},"\u002Frender\u002Fguides","render\u002F2.guides",[353,357,361,365,369,373,377],{"title":354,"path":355,"stem":356},"Panels and layout","\u002Frender\u002Fguides\u002Fpanels-and-layout","render\u002F2.guides\u002F1.panels-and-layout",{"title":358,"path":359,"stem":360},"Layers and labels","\u002Frender\u002Fguides\u002Flayers-and-labels","render\u002F2.guides\u002F2.layers-and-labels",{"title":362,"path":363,"stem":364},"Theming","\u002Frender\u002Fguides\u002Ftheming","render\u002F2.guides\u002F3.theming",{"title":366,"path":367,"stem":368},"Locale and units","\u002Frender\u002Fguides\u002Flocale-and-units","render\u002F2.guides\u002F4.locale-and-units",{"title":370,"path":371,"stem":372},"Legends","\u002Frender\u002Fguides\u002Flegends","render\u002F2.guides\u002F5.legends",{"title":374,"path":375,"stem":376},"Zoom, pan and highlights","\u002Frender\u002Fguides\u002Finteraction","render\u002F2.guides\u002F6.interaction",{"title":378,"path":379,"stem":380},"Using it in a framework","\u002Frender\u002Fguides\u002Fframeworks","render\u002F2.guides\u002F7.frameworks",{"title":217,"path":382,"stem":383,"children":384},"\u002Frender\u002Fapi","render\u002Fapi\u002Findex",[385],{"title":217,"path":382,"stem":383},{"title":387,"path":388,"stem":389,"children":390},"Utils","\u002Futils","utils",[391,393,403,439],{"title":134,"path":388,"stem":392},"utils\u002Findex",{"title":175,"path":394,"stem":395,"children":396,"page":120},"\u002Futils\u002Fgetting-started","utils\u002F1.getting-started",[397,400],{"title":180,"path":398,"stem":399},"\u002Futils\u002Fgetting-started\u002Finstallation","utils\u002F1.getting-started\u002F1.installation",{"title":184,"path":401,"stem":402},"\u002Futils\u002Fgetting-started\u002Ffirst-use","utils\u002F1.getting-started\u002F2.first-use",{"title":188,"path":404,"stem":405,"children":406,"page":120},"\u002Futils\u002Fguides","utils\u002F2.guides",[407,411,415,419,423,427,431,435],{"title":408,"path":409,"stem":410},"Geometry and volumes","\u002Futils\u002Fguides\u002Fgeometry-and-volumes","utils\u002F2.guides\u002F1.geometry-and-volumes",{"title":412,"path":413,"stem":414},"Water levels and pumping tests","\u002Futils\u002Fguides\u002Fpumping-tests","utils\u002F2.guides\u002F2.pumping-tests",{"title":416,"path":417,"stem":418},"Permits","\u002Futils\u002Fguides\u002Fpermits","utils\u002F2.guides\u002F3.permits",{"title":420,"path":421,"stem":422},"Operation and production","\u002Futils\u002Fguides\u002Foperation","utils\u002F2.guides\u002F4.operation",{"title":424,"path":425,"stem":426},"Water quality","\u002Futils\u002Fguides\u002Fwater-quality","utils\u002F2.guides\u002F5.water-quality",{"title":428,"path":429,"stem":430},"Logger import","\u002Futils\u002Fguides\u002Flogger-import","utils\u002F2.guides\u002F6.logger-import",{"title":432,"path":433,"stem":434},"SIAGAS import","\u002Futils\u002Fguides\u002Fsiagas-import","utils\u002F2.guides\u002F7.siagas-import",{"title":436,"path":437,"stem":438},"Formatting","\u002Futils\u002Fguides\u002Fformatting","utils\u002F2.guides\u002F8.formatting",{"title":217,"path":440,"stem":441,"children":442},"\u002Futils\u002Fapi","utils\u002Fapi\u002Findex",[443],{"title":217,"path":440,"stem":441},[445],{"title":223,"path":224,"stem":225,"children":446,"page":120},[447],{"title":448,"path":324,"stem":449,"children":450,"page":120},"Spec","format\u002Fspec",[451,460,469],{"title":452,"path":453,"stem":454,"children":455,"page":120},"Reference","\u002Fformat\u002Fspec\u002Freference","format\u002Fspec\u002Freference",[456],{"title":457,"path":458,"stem":459},"FGDC Texture Patterns Reference","\u002Fformat\u002Fspec\u002Freference\u002Ffgdc-textures","format\u002Fspec\u002Freference\u002Ffgdc-textures",{"title":461,"path":462,"stem":463,"children":464,"page":120},"V1","\u002Fformat\u002Fspec\u002Fv1","format\u002Fspec\u002Fv1",[465],{"title":466,"path":467,"stem":468},".well File Format Specification","\u002Fformat\u002Fspec\u002Fv1\u002Fwell-format","format\u002Fspec\u002Fv1\u002Fwell-format",{"title":470,"path":471,"stem":472,"children":473,"page":120},"V2","\u002Fformat\u002Fspec\u002Fv2","format\u002Fspec\u002Fv2",[474,478,482,486,490],{"title":475,"path":476,"stem":477},".well File Format Specification — Version 2.4: Format Reference","\u002Fformat\u002Fspec\u002Fv2\u002Fformat-reference","format\u002Fspec\u002Fv2\u002Fformat-reference",{"title":479,"path":480,"stem":481},".well File Format Specification — Version 2.4: Interoperability","\u002Fformat\u002Fspec\u002Fv2\u002Finteroperability","format\u002Fspec\u002Fv2\u002Finteroperability",{"title":483,"path":484,"stem":485},".well File Format Specification — Version 2.4: Object Schemas","\u002Fformat\u002Fspec\u002Fv2\u002Fobject-schemas","format\u002Fspec\u002Fv2\u002Fobject-schemas",{"title":487,"path":488,"stem":489},".well File Format Specification — Version 2.4: Overview","\u002Fformat\u002Fspec\u002Fv2\u002Foverview","format\u002Fspec\u002Fv2\u002Foverview",{"title":491,"path":492,"stem":493},".well File Format Specification — Version 2.4: Water Quality","\u002Fformat\u002Fspec\u002Fv2\u002Fwater-quality","format\u002Fspec\u002Fv2\u002Fwater-quality",[495,501,507],{"title":168,"path":169,"stem":170,"children":496,"page":120},[497],{"title":498,"path":499,"stem":500},"@welldot\u002Fcore","\u002Fcore\u002Fchangelog","core\u002FCHANGELOG",{"title":333,"path":334,"stem":335,"children":502,"page":120},[503],{"title":504,"path":505,"stem":506},"@welldot\u002Frender","\u002Frender\u002Fchangelog","render\u002FCHANGELOG",{"title":387,"path":388,"stem":389,"children":508,"page":120},[509],{"title":510,"path":511,"stem":512},"@welldot\u002Futils","\u002Futils\u002Fchangelog","utils\u002FCHANGELOG",1793050502206]