https://docs.optrix.com.au/ Wed, 27 May 2026 01:25:52 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/samplestream:adaptable_example Adaptable Example In the previous example, we hard-coded the distance between each of our assets when requesting a lag-corrected query. This would mean the code wouldn't be able to adapt to changes, move between various different lines, or deal with flexible systems that adjust for specific products. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:ai_array ai_array() This is a function of the sample class. Parameters None Description Returns the content of the data-frame as an array. Returns The returned array will be either a flat array (when you have only a single channel of data), or an array in time/column order. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:ai_conv ai_conv() This is a function of the sample class. Parameters None Description Returns the content of the data-frame as a multi-dimensional array. Returns When working with single-channel data, the array returned by ai_array doesn't have the right structure to be used in convolutional or RNN networks. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:building_backwards Looking Backwards One key thing to keep in mind is that the lag correction classes only work backwards. This is because you can easily reach 'now' when scanning forwards, meaning you need data from the future in order to synchronise your data. To prevent this, you should always work in reverse - starting from the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:class_lagcorrectedquery LagCorrectedQuery Class The LagCorrectedQuery class uses a samplestream to search backwards in time to produce a single data-frame that includes lag-corrected values. This allows you to easily create analytics that compare quality or deal with lag caused by the distance between different sensors along a line. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:class_lagcorrection LagCorrection Class The LagCorrection class uses a samplestream to search backwards in a query, looking for a certain amount of a given value to have passed. The class has the following functions... Amount Rate anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:class_sample Sample Class The sample class is returned when you call NextSample from the samplestream object. It contains the following members... time A datetime (in UTC) for the sample. data A Pandas DataFrame containing the values of the sample. This dataframe has an index of anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:class_samplestream SampleStream Class The samplestream class used to iterate over an AQL query at high resolution, using a sliding window of evenly-spaced points. It's the main class you'll be using when using SampleStream. Functions The class contains the following functions anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:data-driven_lag Data-Driven Lag What Is Lag? Lag between various sensors and pieces of equipment is common. There are a number of reasons why lag exists, but they are usually caused by needing to overcome either distance or inertia, such as... * A machine taking a while to reach top speed, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:distance Distance The documentation will sometimes refer to distance when it comes to correcting lag. Although distance-between-sensors is one of the most common causes of lag, please note that you don't have to be dealing with actual length measurements when we refer to distance. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:end_asset End Asset The end asset is the last asset in any set of assets you're using in your queries. For example, in the image below... The Inspection Station is the last place your cupcakes reach, so it is the End Asset. When entering in the Lag values into functions like anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:example_timings Example SampleStream Timings The parameters you use when creating your samplestream depend on your application and what you're hunting for. High-Resolution Scans Are you looking for events that only show up at 20-millisecond resolution? You can scan long time frames at high resolution using settings like these anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:example Cupcake Example In this case, we're going to ask for both the oven temperature and final colour on a cupcake-making machine. These two pieces of equipment are 50m apart from one-another. Example Chart This is what a chart of our temperature and colour values looks like at the moment. Thanks to the distance between the two components, there's a significant amount of lag between the readings from the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:fn_start Start This is a function of the samplestream class. Description This initialises the SampleStream object and makes the first AQL query, loading data into the buffer to be browsed with NextSample. This is automatically called the first time you call NextSample. Parameters anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:gathersamples GatherSamples This is a function of the samplestream class. Description This function retrieves samples for specific times. The most common use for this function is to request training data for training or testing AI - in particular those AIs that are used for event detection or categorisation, which will often want individual 'snapshots' of particular moments. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lc_amount Amount This is a function of the LagCorrection class. Description This function is used to calculate a data-driven lag time based on a counter. Use this if the source of your lag is being counted or totalised instead of being measured as a rate. Note that in many industrial applications, field-based counters or totalisers are more accurate than performing calculations on rates. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lc_rate Rate This is a function of the LagCorrection class. Description This function is used to calculate a lagged time based on a rate. Use this if the source of your lag is counting the speed or rate that your target is moving, instead of being measured with a counter. Note that in many industrial applications, field-based counters or totalisers are more accurate that performing calculations than rates are. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lcq_addquery AddQuery This is a function of the LagCorrectedQuery class. Description This adds an AQL query that should be run when you Execute the finished request. Parameters ParameterTypeMeaningquerystringThe AQL query to runlagfloatThe amount of lag to apply to this query Returns anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lcq_amountlagquery AmountLagQuery This is a function of the LagCorrectedQuery class. Description This sets up the source of lag for the query. In this case, the query will usually return a single point, which is usually some form of counter or totaliser. Parameters ParameterTypeMeaning anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lcq_constructor LagCorrectedQuery Constructor This is a function of the LagCorrectedQuery class. Description This sets up an empty LagCorrectedQuery Parameters ParameterTypeMeaningserverardiapi.ServerA Server object from the ardiapi library for the server to query Returns An instance of the class anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lcq_execute Execute This is a function of the LagCorrectedQuery class. Description This function returns the complete, lag-corrected data query. Parameters ParameterTypeMeaningstartdatetimeThe starting time for the queryendstringThe end time for the querysamplesintThe number of samples for the query anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:lcq_ratelagquery AmountLagQuery This is a function of the LagCorrectedQuery class. Description This sets up the source of lag for the query. In this case, the query will usually return a single point, which is usually some form of rate meter. Parameters ParameterTypeMeaningnamestring anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:nextsample NextSample This is a function of the samplestream class. Description This gets the next sample from the SampleStream. This includes both a time for the sample, and a Pandas Dataframe that includes each of the query points placed into evenly-spaced time buckets. Parameters anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:number_of_samples Number of Samples The Number of Samples of a SampleStream controls the resolution of the data in each window. This is usually determined by the speed of the data inside the events you're looking for. Take a look at some example timings for inspiration. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:override Override This is a function of the samplestream class. Description This function overrides the default metadata sent from the ARDI server about the query points. The most common use for this function is to override the min and max values for analogue channels to fit the real working range rather than the display range. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:samplestream_construct SampleStream Constructor This is a function of the samplestream class. Description This sets up the basic parameters of a SampleStream object. Parameters ParameterTypeMeaningserverardiapi.ServerA Server object from the ardiapi library for the server to query anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:see_an_example SampleStream Example In this case, we're going to perform a search for the last time Turbine #1 from the Optrix Wind Farm Demo was offline for more than a second. First, we import the libraries we need... import ardiapi import samplestream Then we connect to our ARDI server anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:simple_lag Simple Lag The lag compensating classes (such as LagCorrectedQuery) are only designed to operate on simple forms of data-driven lag. By 'simple', we mean that... All Assets Share The Same Source of Lag All of the assets in your query need to share the same source of lag. For example, conveyor systems will often have anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:source Lag Source All lag happens for a reason. For data-driven lag, you compensate for lag using a data point. This data point is called the Source of Lag, since it measures the reason the lag exists (ie. the distance between sensors). This data point will almost always be either a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:span Span This is a function of the samplestream class. Description This function sets the minimum and maximum span of the search. The first time you call NextSample, your data will either begin at the minimum and move forwards, or begin at the maximum and move backwards, depending on your anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:ssintro Introducing SampleStream How It Works SampleStream lets you iterate over a query. SampleStream takes an AQL request, a window size, a number of samples and a step size. Every time you ask SampleStream for the next sample of data, it returns the data for window size seconds of data, broken into anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:start SampleStream SampleStream is a small Python library used to extract data from ARDI for time-series analysis. It's particularly useful for... * AI applications where you need to work on time-series data, * Applications where you need to search for events across time-windows, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:step_size Step Size A SampleStream iterates through your query time. Every time you call NextSample, your stream moves a certain number of seconds forwards (with a positive step size) or backwards (with a negative step size) in time. A positive step size results in a sample stream that begins at the start time and continues until you hit the end time, or stop calling anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:stream_span Stream Span Even if you're using your SampleStream to search a period of time, you need to set limits. The span of your SampleStream is the minimum and maximum time you'd like to search. When you're looking for the signature of a fault in high-resolution data, your time span is often quite small and fixed - such as scanning only the last hour. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:view_the_documentation Class Documentation sample samplestream LagCorrection LagCorrectedQuery anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/samplestream:window_size Window Size The Window Size of a SampleStream is the amount of time each returned sample should cover. This is usually determined by the speed of the event you're looking for. Take a look at some example timings for inspiration. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000