Cortex API
  • Getting Started
  • Connecting to the Cortex API
  • Overview of API flow
  • Authentication
    • getCortexInfo
    • getUserLogin
    • requestAccess
    • hasAccessRight
    • authorize
    • generateNewToken
    • getUserInformation
    • getLicenseInfo
  • Headsets
    • controlDevice
    • queryHeadsets
    • updateHeadset
    • updateHeadsetCustomInfo
    • syncWithHeadsetClock
    • Headset object
  • Sessions
    • createSession
    • updateSession
    • querySessions
    • Session object
  • Data Subscription
    • subscribe
    • unsubscribe
    • Data sample object
  • Records
    • createRecord
    • stopRecord
    • updateRecord
    • deleteRecord
    • exportRecord
    • queryRecords
    • getRecordInfos
    • configOptOut
    • requestToDownloadRecordData
    • Record object
  • Markers
    • injectMarker
    • updateMarker
    • Marker object
  • Subjects
    • createSubject
    • updateSubject
    • deleteSubjects
    • querySubjects
    • getDemographicAttributes
    • Subject object
  • BCI
    • queryProfile
    • getCurrentProfile
    • setupProfile
    • loadGuestProfile
    • getDetectionInfo
    • training
    • Readonly profile
  • Advanced BCI
    • getTrainedSignatureActions
    • getTrainingTime
    • facialExpressionSignatureType
    • facialExpressionThreshold
    • mentalCommandActiveAction
    • mentalCommandBrainMap
    • mentalCommandGetSkillRating
    • mentalCommandTrainingThreshold
    • mentalCommandActionSensitivity
  • Warning Objects
  • Error Codes
  • Troubleshooting Guide
  • Release Notes
  • cortexaccess tool
Powered by GitBook
On this page
  • Parameters
  • Result
  • Examples
  1. Advanced BCI

mentalCommandBrainMap

PreviousmentalCommandActiveActionNextmentalCommandGetSkillRating

Last updated 4 years ago

This method returns the brain map of a profile. The brain map is a graphic representation of the mental command training of the user. It indicates which actions are most distinct from each other and from the neutral state as measured by how often the training data is misclassified. The better training you do, the more separated the coordinates will be.

Check out the usage in our app.

Parameters

Name

Type

Required

Description

cortexToken

string

yes

profile

string

no

A profile name.

session

string

no

You must set one of these 2 parameters: profile or session. for details.

Result

The result is an array of objects. Each object is represents a trained actions and contains these fields:

Name

Type

Description

action

string

The action name.

coordinates

array of 2 numbers

The (x, y) coordinates of this action in the brain map. x is in range [-1.0, 1.0] and y is in range [0.0, 1.0].

Examples

{
    "id": 5891714,
    "jsonrpc": "2.0",
    "method": "mentalCommandBrainMap",
    "params": {
        "cortexToken": "xxx",
        "profile": "cortex-v2-example",
        "session": "1d5d3655-d570-4731-9faf-967bc5440dc5"
    }
}
{
    "id": 5891714,
    "jsonrpc": "2.0",
    "result": [
        {
            "action": "neutral",
            "coordinates": [0,0]
        },
        {
            "action": "push",
            "coordinates": [0.08947246481272716,0.1596770200887308]
        }
    ]
}

A token returned by .

A session id returned by .

authorize
createSession
BCI
Read this