Zone management system for spatial region-based object detection filtering.
This module provides tools for defining geometric zones and automatically filtering detections based on their spatial relationship to these zones. Supports multiple trigger strategies and statistical tracking for computer vision applications.
Represents a single detection zone with polygon boundary and configurable trigger strategies.A Zone defines a spatial region for filtering object detections based on their bounding box relationship to the zone polygon. Supports multiple trigger strategies including center point, overlap percentage, and intersection detection.
Manages multiple detection zones and automatically updates results with zone information.The Zones manager handles a collection of Zone objects and provides batch processing of detections against all zones. Updates detection objects with zone membership information and maintains zone statistics.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Datamarkin Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/datamarkin/YfQMO_8xl1Lx5v4g/logo/light.svg?fit=max\u0026auto=format\u0026n=YfQMO_8xl1Lx5v4g\u0026q=85\u0026s=88d24086cdf1f1b4327f01a4457b7c3b","dark":"https://mintcdn.com/datamarkin/YfQMO_8xl1Lx5v4g/logo/dark.svg?fit=max\u0026auto=format\u0026n=YfQMO_8xl1Lx5v4g\u0026q=85\u0026s=4a5f914002a5c99505de418c703cd9bc","href":"https://datamarkin.com"},"favicon":"/favicon.png","navbar":{"links":[{"label":"GitHub","href":"https://github.com/datamarkin"}],"primary":{"type":"button","label":"Get Started","href":"https://datamarkin.com/"}},"footer":{"socials":{"github":"https://github.com/datamarkin","twitter":"https://twitter.com/datamarkin"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/datamarkin"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"datamarkin","hasAudioNarration":false,"actualSubdomain":"datamarkin","customDomains":["docs.datamarkin.com"],"gitSource":{"type":"github","owner":"datamarkin","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae93ece42dd55d8fa0c7c4b:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"PixelFlow","count":21},{"language":"default","tag":"AgentUI","count":16},{"language":"default","tag":"Mozo","count":12},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Annotators","count":10},{"language":"default","tag":"Writing Content","count":8},{"language":"default","tag":"AI Tools","count":6},{"language":"default","tag":"Endpoint Examples","count":4},{"language":"default","tag":"Customization","count":4},{"language":"default","tag":"Processing Tools","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pixelflow/zones","slug":"/pixelflow/zones","pageMetadata":{"title":"Zones","description":"Zone management system for spatial region-based object detection filtering.","href":"/pixelflow/zones"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Zone management system for spatial region-based object detection filtering.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This module provides tools for defining geometric zones and automatically filtering detections based on their spatial relationship to these zones. Supports multiple trigger strategies and statistical tracking for computer vision applications.`}),`\n`,_jsx(Heading,{level:`2`,id:`classes`,children:`Classes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#zone`,children:_jsx(_components.code,{children:`Zone`})}),` - Represents a single detection zone with polygon boundary and configurable trigger strategies.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#zones`,children:_jsx(_components.code,{children:`Zones`})}),` - Manages multiple detection zones and automatically updates results with zone information.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`zone`,children:`Zone`}),`\n`,_jsx(_components.p,{children:`Represents a single detection zone with polygon boundary and configurable trigger strategies.`}),`\n`,_jsx(_components.p,{children:`A Zone defines a spatial region for filtering object detections based on their bounding box relationship to the zone polygon. Supports multiple trigger strategies including center point, overlap percentage, and intersection detection.`}),`\n`,_jsx(Heading,{level:`2`,id:`zones`,children:`Zones`}),`\n`,_jsx(_components.p,{children:`Manages multiple detection zones and automatically updates results with zone information.`}),`\n`,_jsx(_components.p,{children:`The Zones manager handles a collection of Zone objects and provides batch processing of detections against all zones. Updates detection objects with zone membership information and maintains zone statistics.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Zones","description":"Zone management system for spatial region-based object detection filtering.","href":"/pixelflow/zones"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Classes","slug":"classes","depth":2,"children":[]},{"title":"Zone","slug":"zone","depth":2,"children":[]},{"title":"Zones","slug":"zones","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"datamarkin","siteName":"Datamarkin Documentation","title":"Zones - Datamarkin Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"pixelflow/zones.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Zone management system for spatial region-based object detection filtering.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Datamarkin Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/datamarkin/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/datamarkin/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/datamarkin/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/datamarkin/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Zones - Datamarkin Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Zone management system for spatial region-based object detection filtering.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Datamarkin Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.datamarkin.com/pixelflow/zones\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://datamarkin.mintlify.site/_mintlify/api/og/v2?division=Zones\u0026amp;title=Zones\u0026amp;description=Zone+management+system+for+spatial+region-based+object+detection+filtering.\u0026amp;theme=96cce6c97aae97c0e3e6ff76\u0026amp;signature=98fab2274c3c703c1fc682d2ca4ef5a34b858ef83ae5184834692fbc08983707\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Zones - Datamarkin Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Zone management system for spatial region-based object detection filtering.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://datamarkin.mintlify.site/_mintlify/api/og/v2?division=Zones\u0026amp;title=Zones\u0026amp;description=Zone+management+system+for+spatial+region-based+object+detection+filtering.\u0026amp;theme=96cce6c97aae97c0e3e6ff76\u0026amp;signature=98fab2274c3c703c1fc682d2ca4ef5a34b858ef83ae5184834692fbc08983707\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/datamarkin/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Datamarkin Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.datamarkin.com/pixelflow/zones\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pixelflow/zones.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.datamarkin.com/#organization\",\"name\":\"Datamarkin Documentation\",\"url\":\"https://docs.datamarkin.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/datamarkin/YfQMO_8xl1Lx5v4g/logo/light.svg?fit=max\u0026auto=format\u0026n=YfQMO_8xl1Lx5v4g\u0026q=85\u0026s=88d24086cdf1f1b4327f01a4457b7c3b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.datamarkin.com#website\",\"name\":\"Datamarkin Documentation\",\"url\":\"https://docs.datamarkin.com\",\"publisher\":{\"@id\":\"https://docs.datamarkin.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.datamarkin.com/pixelflow/zones#webpage\",\"url\":\"https://docs.datamarkin.com/pixelflow/zones\",\"name\":\"Zones\",\"description\":\"Zone management system for spatial region-based object detection filtering.\",\"isPartOf\":{\"@id\":\"https://docs.datamarkin.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.datamarkin.com/pixelflow/zones#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.datamarkin.com/pixelflow/zones#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Datamarkin Documentation\",\"item\":\"https://docs.datamarkin.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Zones\",\"item\":\"https://docs.datamarkin.com/pixelflow/zones\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.datamarkin.com/pixelflow/zones#article\",\"headline\":\"Zones\",\"name\":\"Zones\",\"description\":\"Zone management system for spatial region-based object detection filtering.\",\"url\":\"https://docs.datamarkin.com/pixelflow/zones\",\"mainEntityOfPage\":{\"@id\":\"https://docs.datamarkin.com/pixelflow/zones#webpage\"},\"publisher\":{\"@id\":\"https://docs.datamarkin.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.datamarkin.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Datamarkin Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Datamarkin Documentation","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/datamarkin"}]},"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":""}]},{"tab":"PixelFlow","groups":[{"group":"Getting Started","pages":[{"title":"PixelFlow","href":"/pixelflow"},{"title":"Quickstart","href":"/pixelflow/quickstart"}]},{"group":"Detections","pages":[{"title":"Detections","href":"/pixelflow/detections/detections"},{"title":"Converters","href":"/pixelflow/detections/converters"},{"title":"Filters","href":"/pixelflow/detections/filters"}]},{"group":"Annotators","pages":[{"title":"Anchors","href":"/pixelflow/annotators/anchors"},{"title":"Blur","href":"/pixelflow/annotators/blur"},{"title":"Box","href":"/pixelflow/annotators/box"},{"title":"Crossings","href":"/pixelflow/annotators/crossing"},{"title":"Label","href":"/pixelflow/annotators/label"},{"title":"Mask","href":"/pixelflow/annotators/mask"},{"title":"Oval","href":"/pixelflow/annotators/oval"},{"title":"Pixelate","href":"/pixelflow/annotators/pixelate"},{"title":"Polygon","href":"/pixelflow/annotators/polygon"},{"title":"Zones","description":"Draw polygon zones on images with customizable styling and intelligent labeling.","href":"/pixelflow/annotators/zones"}]},{"group":"Zones","pages":[{"title":"Zones","href":"/pixelflow/zones"},{"title":"Crossings","href":"/pixelflow/crossings"},{"title":"Strategies","href":"/pixelflow/strategies"}]},{"group":"Object Tracking","pages":[{"title":"Bytetracker","href":"/pixelflow/tracker/bytetrack"}]},{"group":"Processing Tools","pages":[{"title":"Buffer","href":"/pixelflow/buffer"},{"title":"Smooth","href":"/pixelflow/smoother"},{"title":"Slicer","href":"/pixelflow/slicer"}]},{"group":"Analytics","pages":[{"title":"Timetracker","href":"/pixelflow/timer"}]}]},{"tab":"Mozo","pages":[{"title":"Mozo","href":"/mozo"}]},{"tab":"AgentUI","pages":[{"title":"AgentUI","href":"/agentui"}]}]},"basePath":"","title":"Zones - Datamarkin Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}