Difference between revisions of "OSCAR - The Guide"

Revision as of 21:27, 19 February 2021

This article is part of the official OSCAR software project. (OSCAR Help)

OSCAR - the Open Source CPAP Analysis Reporter

OSCAR is software that is compatible with Windows, Mac, and Linux operating systems, developed for reviewing and exploring data produced by supported CPAP, bilevel, ventilators, and related machines used in the treatment of sleep apnea. Oscar requires that data is collected on an SD card which MUST be inserted into the PAP machine during use to record detailed data.

Common features of detailed graphs

Left side-bar

The left part of the Daily screen is referred to as the 'left side-bar. It contains details of your machine and its settings, your AHI and other sleep indicators, and the amount of time you were asleep. Starting from the top, the key parts of the left side-bar are Program identification, menu and tabs, as found on all screens within OSCAR The current date. Click the small green arrows to move back & forth by one day. Click the Green arrow & bar >| to move to the latest date with data. Click the small black triangle to make the calendar appear or disappear. Tabs to select details, events, notes and bookmarks. These will be discussed in greater detail below. AHI Summary. This is your apnea / hypopnea index for the sessions under review. It is the total number of apneas and hypopneas divided by the total hours of sleep. Generally this will be for the whole night, however if you have turned any sessions on or off (See No 11 below) then the AHI is given only for the sessions turned on. Machine type and settings summary. This gives the make and model of CPAP machine. The PAP mode is the particular algorithm set on the machine (many machines can operate in more than one mode). It also shows the pressure settings. If you hover the mouse curser over the machine name, the model number and serial number will appear in a pop-up box. Note: The settings for PC, S, and S/T modes on Philips Respironics System One machines may be displayed as random garbage numbers - this is a known problem and will be fixed in a later release of Oscar. Session starting, ending and total times. Shows when the machine was turn on and off, and the total elapsed time. Note that although this is used to calculate the time asleep, the CPAP machine has no way of knowing if you were actually asleep or not. Event rates per hour. A simplified view of the different types of events you have experienced. Note that some machines display more or fewer event types, and these can be selected in the Event flag selector on the Daily page. Statistics for pressure, leaks, snores and respiration. Detailed information about your respiration throughout the night. The statistics panel gives details of your pressures, minute ventilation, respiration rate and other important parameters. For each parameter (referred to as a 'channel') the panel shows the minimum recorded, the median, 95th percentile and the maximum. Also shown are the total time in apnea, and the time over the leak redline. For Resmed machines this is 24 L/min. For all machines the redline number can be set in the menu File | Preferences | CPAP. Machine Settings Details. A more complete set of machine settings giving you the pressure and other settings for your machine. The settings shown will vary according to the type of machine. Session Information. Each time the machine is started then stopped is called a session. If you sleep right through the night, that is a single session. If you stop the machine for a toilet break then start it again, then two sessions will be recorded. Buttons (bars) to turn sessions on and off. Clicking on these buttons will include or exclude sessions from display of the night's data. Clicking on the blue and yellow session buttons will include or exclude sessions from the display of the night's data. This can be useful if (for example) you had a very brief nap in the afternoon and want to exclude it from the night's results. Note that turning a session off will change the calculated AHI for the night. Note also that sessions can be turned on and off using the small green/black buttons in the section information panel. When a session is off the button changes to black / red.

The Calendar

The calendar can be useful for navigation, but if you are posting an OSCAR Daily Detail graph on the forum, it should be minimized. To minimize the monthly calendar, just click on the triangle to the left of the current date. If you click on a date in the calendar, the daily data for that date loads into the daily data window. It's also important to understand that the data for any particular date is the data for the NIGHT that started on on that date and ended the following morning. And that's true regardless of whether you get to bed before midnight. Now look at the little arrows in the calendar. The two arrows that surround the bubble with the highlighted date move one day backward or forward. The third outside arrow on the far right ->| will immediately jump to the last date with data. The two arrows on the blue bar with the month's name allow you to jump forward or backwards by a month. Pressing the downward triangle between the month and the year allows you to quickly change to a different month. Clicking the year allows you to quickly change to a different year. Pressing the upward facing arrow in the bubble with the the date in it will hide the calendar and change that triangle to a downward facing triangle. Clicking the downward facing triangle will show the calendar. The calendar covers up a lot of useful information and should always be hidden when making screenshots for uploading to a forum.

Pie Chart

You can see a pie chart depicting the breakdown of your events. To turn the pie chart on and off, go to the File menu and select File | Preferences | Appearance. For posting charts to the forum it's best to turn the pie chart off as it covers up more valuable information.

Summary Information (AHI, Machine, Hours, Event rates)

Items 4, 5, 6, and 7 in the side bar image are collectively the summary information. They show your apnea-hypopnea index (AHI), brief details of your machine and its settings, the time you slept, and the events which occurred during your sleep.

Note that the AHI shown is only for the 'sessions' which are turned on (see below). The summary of events will only show those which are turned on in the event flag selector. The available events will vary among different types of machine.

Tabs: Details, events, notes and bookmarks

The Details tab is the default view which shows the statistics, machine settings etc. The Events tab Shows every apnea, hypopnea, large leak and other significant events during the night. The numbers in brackets are the duration of the event in seconds. Clicking on any event will zoom the chart to show that event in detail. The Notes tab allows you to keep a daily journal of your sleep experience. There are basic formatting buttons available as well as a slider to register how you feel (on a scale of Zombie to Awesome). You can also enter your weight each day. The notes for a particular day can be included in the printed report. It's necessary to deselect all graphs except one, using the chart selector menu at the bottom right of the page. To print the report, go to the menu File | Print Report. Notes you have saved will be included in the printout. You can export all your notes as an xml file for backup purposes or additional analysis. Use the menu option File | Backup Journal. Oscar will calculate your body mass index (BMI) at the bottom of the Notes section. You must enter your weight each day. You must also enter your height in your profile (see Running Oscar for the First Time ). If either the weight or height are not entered the BMI calculation will not appear. The Bookmarks tab lets you record the time of significant events you may wish to refer back to, such as an exceptionally long apnea. Creating a bookmark Bookmarks are created using the [bookmark tab] on the daily page: Click on the tab to open bookmarks On the flow rate graph, place the cursor on the event you wish to record (eg an apnea) Click the Add Bookmark button. A bookmark stating the time and date will be created. You can add text to a bookmark: Select the bookmark Double-click the words "Bookmark at xx:xx:xx" in the Notes column Type in your text Press Enter. Reviewing bookmarks In the [right sidebar] click on the Bookmarks button at the bottom of the sidebar. The sidebar will show a list of all the bookmarks which have been created. To go to a particular bookmark, click on the date. OSCAR will open the daily page at that particular date. You can then click on a bookmark and OSCAR will adjust the display to show the event which has been selected. You can search for particular text in your bookmarks using the search window at the top of the sidebar (under the word Bookmarks). Deleting bookmarks In the Daily page, select the bookmark you wish to delete, then click "Remove Bookmark" at the bottom of the panel.

The daily detailed graphs

The main part of the daily page is given over to the detailed graphs. These allow you to inspect all the important things which happened during the night, right down to a breath-by-breath review.

Common features of detailed graphs

Each daily graph chart has a number of features in common:

• Turn graphs on or off: You can turn individual graphs on and off using the chart selector at the bottom right corner of the chart area. Click on the selector and a small menu will pop up, listing all the available graphs. Click on any one to turn it on or off. When turned on, the item will show a small green & black icon. If turned off, it will show a red and black icon. The available graphs will depend on your machine, and on settings in the preferences dialog.
• Zoom level: The default view shows the whole night's chart compressed onto a single panel. You can zoom in and out for a closer view as follows:

1. Left click anywhere on a graph;
2. Right click anywhere to zoom out;
3. Place the cursor on a graph, hold the Ctrl button and rotate the scroll wheel;
4. Use the keyboard Up Arrow to zoom in and the Down Arrow to zoom out;
5. To zoom out to the full view you can also right click on any graph title and select "100% zoom level". Alternatively press and hold the Escape (Esc) key or Down Arrow on your keyboard for a couple of seconds.

• Time scale: Along the bottom of each graph is a time scale to show when events occurred.
• Pin chart in position: Double-click on the title of a graph to pin it in position. Once pinned, the graph will appear at the top of the screen and will not scroll with the other graphs.
• Resize chart: You can change the vertical height of any graph by clicking in the divider line and dragging it up or down.
• Pop out chart: Right click on the graph label and select "Popout graph". A copy of the graph will be created in its own window, which can them be placed anywhere on the screen. If you pop out more than one graph, they will share a common window.
• Clone graph: Right click on the graph label and select "Clone graph". A copy of the graph will be created below the original. The cloned graph can be zoomed independently of all other graphs. To remove the clone, right click on the title and select "Remove clone".
• Reset graph layout: If you have changed the vertical height of one or more graphs, double click on a graph title and select "Reset graph layout". All graphs will be restored to their normal height.
• Y Axis: If you want to change the vertical scale of a graph, right click in the label of a graph and select "Y axis". A small pop-up will show, and give the options Autofit, Defaults and Override. Select override, the adjust the minimum and maximum numbers until the trace on the graph is to your liking. Note that you must keep the mouse cursor within the pop-up - if it strays outside, the pop-up will disappear.

• CPAP overlays: Oscar can include a marker for each of the events on any of the graphs. Right click the graph title and select 'CPAP Overlays'. A pop-up will appear, allowing you to turn on or off each type of event. The events will appear as a short tick along the top of the graph.
• Oximeter overlays: If you have a pulse oximeter synched to Oscar you can display certain parameters using the oximeter overlay option.
• Dotted lines: Oscar will display dotted lines across a graph to aid in reading it. The available lines will vary depending on the particular graph. Right click on a graph title and select "Dotted lines". A pop-up will appear, with a list of available lines which you can turn on or off.

Daily (Standard Charts)

To reset the graph order for the Standard Charts click on View/Reset Graphs/Standard

Event Flags

The Event Flags graph normally appears at the top of the stack. It shows each event (Obstructive Apnea (OA), Cemtral Apnea/Clear Airway (CA), Hypopnea (H), Large Leak (LL), etc.) as a vertical bar. You can select which events to display using the event flag selector at the bottom left of the chart area. The available flags will vary depending on your machine. The graphical display of events is useful in determining whether they occurred at a particular time, in clusters or spaced throughout the night.

Each event type in the Event Flags graph will have a corresponding entry in the sidebar summary area.

First, Events only show if you have had them at some point, OSCAR remembers. If you have NEVER had a Clear Airway/Central Apnea event (CA) recorded, none will show. The same for RERAs (RE), though not all machines report RERAs. Second, if you have previously had an event type such as Clear Airway/Central Apnea event (CA) recorded, that category will always display even if you have none on the current night. The events shown here are all, alright, almost all, reported by your xPAP machine.

The exception: In the File/Preferences/CPAP tab there is a section for those of you that may want to experiment called Custom CPAP User Event Flagging. This allows you to define different Flow Restrictions and Event Durations

Issue - Positional Apnea

Positional Apnea is caused by misalignment of the airway typically tucking the chin down.
It is normally detected by clusters of Obstructive and Hypopnea events usually associated with an uneven and smaller/narrower Flow Rate chart.

see the Wiki article Optimizing_therapy#Positional_Apnea

Other

Correlation with other charts indicating cause and effect

Flow Rate

This graph is probably the most used in analyzing and interpreting CPAP data. It shows airflow in and out of your lungs throughout the night. The flow above the zero line is inhalation and below the line is exhalation. The events are shown on this graph as well as on the event flags graph. You can zoom in to examine an event more closely.

Placing the cursor on any event will create a small pop-up detailing the type and duration of the event in seconds.

Nearly all that is happening throughout the night can be seen in the Flow Rate graph though usually in a zoomed view. Tidal Volumes and Minute Vent can be seen via the 'volume under the curve', flow limits may show as "grassy" on the full night view but are readily apparent when viewed with the breath waveform is readily distinguished, typically 2-3 minutes. Leaks may sometimes be distinguished by a difference in volume between inhale and exhale. Periodic Breathing can be confirmed easily on this chart and serious breathing patterns such as CSR can be identified and Flow Limits become readily apparent.

Pressure

Pressure and Mask Pressure

The pressure graph shows the pressure as it varies over time. The mask pressure graph shows the pressure at the mask on a breath by breath basis.

Zooming in shows how the mask pressure is a high-resolution chart sampled 25 times per second, while the pressure is only sampled once per second. Depending on your machine settings there may be several traces shown - usually the inhale pressure (IPAP) and exhale pressure (EPAP).

Flow Limit.

ResMed: Flow Limits are calculated as an index, 0-1, indicating the flatness of the breath-form on the flow rate chart. Zero means none, severity increasing as the index approaches one. These show as a varying height vertical bar.

Flow Limits are the 'foundation' of obstructive events. The least severe of these events are flow limits followed by hypopnea and then obstructive apnea. They are often identified as a fundamental part of RERAs and UARS Note that on this graph flow limits are under-reported as compared to what we can visualize on the flow rate graph discussed above.

Flow Limits are often the main driver of pressure increases, especially with ResMed devices. Seeing Flow Limits in this graph is almost always accompanied by an increase in pressure as the ResMed algorithms depend heavily on the flow limits that are shown in this graph.

Leak Rate

The leak rate graph indicates whether excessive mask leaking occurred, and to what extent. All CPAP masks are designed to leak or vent surplus air away from the user's nose or mouth. This flushes away the exhaled breath and prevents the user re-breathing his expelled CO2. The actual amount of this designed leak will vary according to the mask. Anything in excess of that amount is "additional leak".

Resmed machines show a single trace indicating the additional leak. By default (in accordance with Resmed guidelines), Oscar flags any additional leak over 24 L/min as an excessive or "large leak". You can adjust the red line between acceptable and unacceptable leaks by using File | Preferences | CPAP | Flag leaks over threshold.

Philips machines show two traces - total leak and additional leak. It is the lower additional leak line which indicates whether the leak is excessive or not.

Leak graph from Resmed machine showing excessive leakage

Leak graph from Philips machine showing upper and lower traces

Snore

Resmed and Philips machines both show snoring as a graph with the height of the trace indicating the intensity of the snoring. In addition, Philips machines show individual snores as events labeled VS1 and VS2 (vibratory snore 1 and 2). It is usually suggested that VS2 be turned off when presenting screenshots for discussion as the large number of events recorded can overwhelm other data on the charts.


OSCAR snore graph from Resmed machine

Zeo Data

If data has been imported from a Zeo sleep monitor device, additional graphs will be available, including Sleep stage,

Daily (Advanced Charts)

To reset the graph order for the Advanced Charts click on View/Reset Graphs/Advanced

Event Flags, Flow Rate see Daily (Standard Charts) for description

Mask Pressure

Tidal Volume

Minute Vent

Insp. Time

Exp. Time

Resp. Rate

Daily (Other Charts)

AHI

Time at Pressure

Donate to Apnea Board